Skip to content

Repository files navigation

PyAvatar
PyAvatar

A desktop window showing every avatar you use, and where you use it — so they stay consistent across the web.

PyPI Build StatePyTest StatePylint StateCodeQL StateGitHub VersionGitHub IssuesGitHub Pull Requests

StatusKey FeaturesInstallationUsageDocumentationSupportContributingCreditsLicense

PyAvatar window

Status

Pre-release, and incomplete on purpose. The window, the grid layout, and the clickable links all work. The avatars themselves do not exist yet: PyAvatar/images.py and PyAvatar/links.py are empty, two placeholder accounts are hardcoded in main.py, and both share one placeholder image.

PLANNING.md tracks what remains — adding the images (0.2.0) and the links (0.3.0) before a 1.0.

Everything below describes what runs today. See docs/roadmap.md for what does not.

Key Features

  • A Tkinter window listing accounts in a five-column grid, wrapping as it fills.
  • Each account shows an image, a name, and a link that opens in your browser.
  • Pure standard library — Tkinter only, nothing to install beyond Python.
  • Cross-platform: Windows, macOS, Linux.

Installation

git clone https://github.com/willtheorangeguy/PyAvatar
cd PyAvatar
python main.py

Running from the repository root matters — see docs/installation.md.

Usage

Launch it and the window lists your accounts. Click a link to open that site.

Adding your own accounts means editing main.py today; see docs/configuration.md.

Documentation

Full documentation lives in docs/: Quickstart · Installation · Configuration · Architecture · Development · Testing · FAQ · Troubleshooting · Roadmap

Support

Open a GitHub Discussion, file an issue, or join the Discord.

Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

See the org-wide Contributing Guide and Code of Conduct.

Credits

This software uses the following open source packages, projects, services or websites:

GitHubPSFPyInstaller
GitHubPython Software FoundationPyInstaller
Web - PlansWeb - DonateWeb - Donate

Sponsor @willtheorangeguy on PayPal.

License

MIT — see LICENSE.md.

About

Easily display all of your creative avatars to keep them consistent across websites.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages