modulepackage
0.0.0-20240617115023-1ebceebb5be8
Repository: https://github.com/ugolinolle/auto-push.git
Documentation: pkg.go.dev
# README

Auto-Push Project
💻・Description
Auto-Push is an automated tool designed to update your biography and GitHub status. It integrates weather features to enable dynamic updates based on weather conditions.
🎯・Installation
pip3 install auto-push
📚・Ressources
⌨️・Setup & Usage
- Add a personnal access token from Settings/Developer Settings :
- Add
repo
authorization. - Add
user
authorization.

- Setup your access token with this command:
auto-push setup --key 1 --value [TOKEN]
-
Create and add an account from Weather API
-
Setup your api key from weather api with tis command:
auto-push setup --key 2 --value [API_KEY]
- For launch github updater, use:
auto-push start
- For see all command, use:
auto-push --help
🧑🤝🧑・Contributing
To use Auto-Push in development, follow these steps:
-
Fork the project.
-
Install poetry.
curl -sSL https://install.python-poetry.org | python3 -
-
Create a branch with conventionnal name.
- fix:
bugfix/the-bug-fixed
- features:
feature/the-amazing-feature
- test:
test/the-famous-test
- hotfix
hotfix/oh-my-god-bro
- wip
wip/the-work-name-in-progress
- fix:
-
Configure your environment variables in
.env
.
GITHUB_PERSONAL_ACCESS=TOKEN
WEATHER_API_KEY=TOKEN
- Run the cli with
python -m auto_push [COMMAND]
🎯・Roadmap
- Implement a new printer.
- Implement custom text.
- Add update status while typing.
📑・Licence
Ce projet est sous licence MIT. Pour plus d'informations, veuillez consulter le fichier LICENSE.
📩・Contact
Pour toute question ou collaboration, n'hésitez pas à me contacter par email ou LinkedIn