Metadata-Version: 2.0 Name: ProjectSetup Version: 0.1.1 Summary: describe your project Home-page: https://github.com/michagrandel/ProjectSetup Author: Micha Grandel Author-email: talk@michagrandel.de License: UNKNOWN Keywords: p,y,t,h,o,n Platform: UNKNOWN Classifier: Development Status :: 1 - Planning Classifier: License :: OSI Approved :: Apache Software License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Operating System :: Microsoft Classifier: Operating System :: Microsoft :: Windows Classifier: Operating System :: Microsoft :: Windows :: Windows 10 Classifier: Operating System :: Microsoft :: Windows :: Windows 7 Classifier: Operating System :: Microsoft :: Windows :: Windows 8 Classifier: Operating System :: Microsoft :: Windows :: Windows 8.1 Classifier: Operating System :: OS Independent Classifier: Operating System :: POSIX :: Linux Classifier: Natural Language :: English Requires-Dist: alabaster (>=0.7.10) Requires-Dist: Babel (>=2.5.3) Requires-Dist: certifi (>=2017.11.5) Requires-Dist: chardet (>=3.0.4) Requires-Dist: colorama (>=0.3.9) Requires-Dist: docutils (>=0.14) Requires-Dist: idna (>=2.6) Requires-Dist: imagesize (>=0.7.1) Requires-Dist: Jinja2 (>=2.10) Requires-Dist: lxml (>=4.1.1) Requires-Dist: MarkupSafe (>=1.0) Requires-Dist: pip (>=9.0.1) Requires-Dist: Pygments (>=2.2.0) Requires-Dist: pytz (>=2017.3) Requires-Dist: requests (>=2.18.4) Requires-Dist: setuptools (>=38.4.0) Requires-Dist: six (>=1.11.0) Requires-Dist: snowballstemmer (>=1.2.1) Requires-Dist: Sphinx (>=1.6.6) Requires-Dist: sphinxcontrib-websupport (>=1.0.1) Requires-Dist: typing (>=3.6.2) Requires-Dist: urllib3 (>=1.22) Requires-Dist: wheel (>=0.30.0) Provides-Extra: dev Provides-Extra: test ProjectSetup ============ |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 `__.* 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 `__. .. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/ProjectSetup.svg :target: http://pypi.python.org .. |Travis| image:: https://img.shields.io/travis/michagrandel/ProjectSetup/master.svg :target: https://travis-ci.org/michagrandel/ProjectSetup .. |Coverage| image:: https://img.shields.io/codecov/c/github/michagrandel/ProjectSetup/master.svg .. |GitHub release| image:: https://img.shields.io/github/release/michagrandel/ProjectSetup.svg :target: https://github.com/michagrandel/releases .. |PyPI| image:: https://img.shields.io/pypi/v/ProjectSetup.svg :target: http://pypi.python.org .. |license| image:: https://img.shields.io/github/license/michagrandel/ProjectSetup.svg :target: https://github.com/michagrandel/ProjectSetup/blob/master/LICENSE .. |PRs Welcome| image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square :target: http://makeapullrequest.com