https://github.com/probably-not/basic-python-package
The basic Python package structure that I use when starting a new Python project, based on the Hitchhiker's Guide with some of my own modifications.
https://github.com/probably-not/basic-python-package
python python-package structure
Last synced: 28 days ago
JSON representation
The basic Python package structure that I use when starting a new Python project, based on the Hitchhiker's Guide with some of my own modifications.
- Host: GitHub
- URL: https://github.com/probably-not/basic-python-package
- Owner: probably-not
- License: mit
- Created: 2018-06-26T04:35:05.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-26T15:27:03.000Z (almost 8 years ago)
- Last Synced: 2025-01-07T06:32:14.748Z (over 1 year ago)
- Topics: python, python-package, structure
- Language: Python
- Size: 5.86 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Basic Python Package Structure
This is my basic Python package structure. It is based on the [Hitchhiker's Guide to Python's Structuring Your Project page](http://docs.python-guide.org/en/latest/writing/structure/), with some of my own additional preferences involved.
## Steps To Use
1. Fork this repository into your own repo on GitHub
1. In setup.py, change the ```NAME```, ```DESCRIPTION```, and ```URL``` variables according to your project's name, descriptionm and url
1. Change the LICENSE file to the license you would like to use
1. Change the name of the {{project_name}} folder to your project's name
1. In tests/context.py, change the final import statement to reflect your project's name
1. And finally, adjust your README.md file accordingly