hello-gh-actions

This package demonstrates building and publishing Python Packages with GitHubs infrastructure


License
MIT
Install
pip install hello-gh-actions==0.0.4

Documentation

Template

This is a template repository for building Python packages. It allows you to quickstart your Python package.

Using it

  • Click on Use this template
  • Customize a couple files:
    • Rename directory ./hello_gh_actions/ to your desired package name
      • Also change ./hello_gh_actions/__init__.py accordingly
    • Replace project details in ./setup.cfg
    • Add your name in ./LICENSE
  • Create an account on readthedocs and connect this repository
  • Create an account on PyPI and generate an API-Key for your project

Go to your repositories "Settings -> Secrets" page and add the PYPI_API_KEY secret with the key you received from PyPI.

Below is a README template for your project, so remove everything above this line.


Hello GitHub Actions!

TODO: CHANGE BADGE URLS AFTER FORKING

Documentation Status Tests Status

Getting started

Installation via pip:

pip install hello_gh_actions

Using the fizzbuzz:

>>> from hello_gh_actions.fizzbuzz import fizzbuzz
>>> fizzbuzz(35)
'fizzbuzz'