https://github.com/cyb3r-jak3/python_template_repo

Template Python Repo for getting started with a Python Library
https://github.com/cyb3r-jak3/python_template_repo

python-library python-template

Last synced: about 5 hours ago
JSON representation

Template Python Repo for getting started with a Python Library

• Host: GitHub
• URL: https://github.com/cyb3r-jak3/python_template_repo
• Owner: Cyb3r-Jak3
• License: mpl-2.0
• Created: 2020-11-23T00:41:13.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-10-16T16:26:19.000Z (about 3 years ago)
• Last Synced: 2024-11-06T18:51:54.257Z (9 days ago)
• Topics: python-library, python-template
• Language: Python
• Homepage:
• Size: 31.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Python Template Repo

---

Template Python Repo for getting started with a Python Library with GitHub.

## Benefits

* GitHub Action Templates

* Auto deploy to PyPi

* Issue and Pull Request Templates

* Auto Configured install and test requires

## To Use

1. Clone the repo

2. Rename the [python_GH_template](python_gh_template) directory to the name of your project.

    * Make sure the names updates in [setup.py](setup.py), [lint workflow](.github/workflows/lint.yml).

3. Install package locally `pip install -e .`

4. Add your project requirements to [requirements.txt](requirements.txt).

    * If you have any development requirements add them to [requirements-dev.txt](requirements-dev.txt).

5. Add tests (or delete if you want)

6. Change the [License](LICENSE) if desired.

7. Edit the assignees in [Issue Templates](.github/ISSUE_TEMPLATE), [Pull Request Template](.github/PULL_REQUEST_TEMPLATE) and [Dependabot Config](.github/dependabot.yml).

8. Edit [setup.py](setup.py) to have relevant links and information. 

9. Add `PYPI_USERNAME` and `PYPI_PASSWORD` into the secrets section.