Skip to content

Dog-Face-Development/PyAvatar

PyAvatar
PyAvatar

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

PyPI Build State PyTest State Pylint State CodeQL State GitHub Version GitHub Issues GitHub Pull Requests Discord Server ID Downloads GitHub Languages

Key FeaturesDownloadHow To UseSupportContributingChangelogCredits & Contributors

Key Features

  • Easy to use GUI interface.
  • Avatar and banner images are displayed for viewing.
  • Website links are clickable.
  • Links to local image storage are clickable.
  • Can add as many images as necessary.
  • Cross platform.

Download

You can download the source code to run the GUI script from the command line on Windows, macOS and Linux. This will require Python.

You can download the latest executable launcher of PyAvatar for Windows. This does not require Python.

How To Use

To run the application, you can use Git and the Python Interpreter, which allows you to clone and run the application, or pip to create a command line application.

Git

To clone and run this application, you'll need Git and Python installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:

# Clone this repository
$ git clone https://github.com/Dog-Face-Development/PyAvatar

# Go into the repository
$ cd PyAvatar

# Run the CLI
$ python main.py

pip

You can install the program from the Python Package Index through pip.

# Install via pip
$ pip install python-avatar

# Run the CLI
$ python-avatar

Support

To view all available websites and their corresponding avatar's, just launch the app!

Customizing the list and location of websites, avatars and links can be found in CUSTOMIZATION.md. More documentation is available in the Documentation and on the Wiki. If more support is required, please open a GitHub Discussion or join our Discord.

Contributing

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

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us (including how to sign our CLA).

Changelog

See the CHANGELOG file for details.

Credits

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

GitHub PSF PyInstaller
GitHub Python Software Foundation PyInstaller
Web - Plans Web - Donate Web - Donate

Contributors

You may also like...

  • ProgramVer - An open-source, Python GUI version window to show copyright info and licenses.
  • PyWorkout - A minimal CLI to keep you inspired during your workout!
  • Periodic-Table-Info - Print all the elements in the Periodic Table of the Elements, with an interactive prompt to learn more.

License

This project is licensed under the GNU General Public License - see the LICENSE file for details. See the Privacy Policy, Terms and Conditions, and EULA for legal information.