python-gh-template 1.0.0

Repo Template for creating a Python library in GitHub

# 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.