Home

Creating a New Repository

To create a new repository from this template:

1. Click the "Use this template" button on the repo's homepage, or go directly to https://github.com/NarrativeScience/python-package-template/generate
2. Choose NarrativeScience as the organization and public or private
3. Clone the repo locally
4. Find and replace all instances of my-package-name and my_package_name with the name of your new Python package.
   • In general the repo name and pip package should be stylized as kebab-case whereas the actual package name (that gets imported in *.py) should be snake_case.
5. Fill out the REAMDE. There are several placeholder comments.