default_python_cookiecutter

A cookiecutter for Python packages according to my typical process. Intended to integrate with PyCharm.

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About the Project

A cookiecutter for Python packages according to my typical process. Intended to integrate with PyCharm.

Getting Started

Prerequisites

• Python 3.7+

Usage

Used with cookiecutter (see here: https://cookiecutter.readthedocs.io/)

• pip install cookiecutter
• cookiecutter gh:dcronkite/default_python_cookiecutter

Versions

Uses SEMVER.

See https://github.com/dcronkite/default_python_cookiecutter/releases.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

See LICENSE or https://dcronkite.mit-license.org for more information.

Contact

Please use the issue tracker.

Acknowledgements