Skip to main content

describe your project

Project description

PythonVersions Travis Coverage GitHub release PyPI license PRs Welcome

Initialize your Python Project

Features

ProjectSetup helps you to get started with your Python Project as fast as possible.

It will handle these tasks for you:

  • initialize a python module named after your project
  • add Community Files
    • Readme.md
    • Contributing.md
    • CODE_OF_CONDUCT.md
    • issue_template.md
    • PULL_REQUEST_TEMPALTE.md
  • add important project files like LICENSE, setup.py, requirements.txt and more
  • initialize Sphinx documentation
  • prepare test-directory with a skipping dummy test
  • build a initial source distribution and python wheel
  • Some additional customizations are done for Jetbrains PyCharm IDE
  • and many more features …

To get a full list of all supported features, please read the `project wiki <https://github.com/michagrandel/ProjectSetup/wiki>`__.

Getting Started

Installing

pip install ProjectSetup

If this doesn’t work, try to download the code, extract the zip-file and run:

python setup.py install -r requirements.txt

How to run

To run the script, just use the quickstart.py-Script in the script-folder.

Customize the settings

To customize everything, you just need to edit the quickstart.py.

In future releases, you will be able to use a command line interface without needing to edit the script code.

Running the tests

If you like to run the tests, just open a terminal in the project directory and run:

python -m unittest discover -s test -p "*_test.py"

Built With

  • lxml combines the speed and XML feature completeness of these libraries with the simplicity of a native Python API
  • Jinja2 is a full featured template engine for Python

Contributing

First of all: Thank you very kindly for your interest in contributing to our code!

Please take a moment and read CONTRIBUTING.md to get you started!

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

Authors

  • Micha Grandel - Author and maintainer - Github

We thank all of our contributors, who participated in this project.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details

Code of Conduct

Everyone interacting in the ProjectSetup project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the Code of Conduct.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ProjectSetup-0.1.1-py2.py3-none-any.whl (15.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jan 18, 2018
ProjectSetup-0.1.1.tar.gz (13.2 kB) Copy SHA256 hash SHA256 Source None Jan 18, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page