Python Archetype

This project contains a simple templating mechanism for creating clean tox-compatible python projects.

Funfact: This archetype project was created using the archetype. Archetype-inception :mind-blow:

Requirements

The archetype project requires Python, PIP and Tox.

Compatibility

Currently, the archetype is tested for Python 3.7, 3.8 and 3.9. It could work out with other Python versions too, but this was not tested and happens on your own risk.

Getting started

Clone the project using git, open a CLI in the cloned folder python-archetype/src/archetype.

The following information is required, regardless of whether the CLI mode or the UI mode is used:

• a project name
• the target python version (e.g. 3.7, 3.8, 3.9, ...)
• the base folder for the created project (basefolder + project name = source of generated project)

After adding the information, you have created a clean python project.

To adapt or test the project have a look at the detailed description here

CLI Mode

In the CLI mode use the archetype.py script to create your target project using the following console arguments:

• -p: The name of your project.
• -v: The target Python version.
• -t: The target base folder.
• -D: If there is an overlapping project with the same name in the targetfolder, delete it.

Like:

python archetype.py -p myNewProject -v 3.7 -t C:/public/ -D

This will create a Tox compatible Python project at: C:/public/myNewProject

UI Mode

In the UI mode just call the archetype.py file like:

python archetype.py

Afterwards you are prompted to input the required information.

How to continue?

How to continue? After the creation of the project follow the steps:

• Update pip if necessary.
• Install tox if necessary
• Fill in your requirements into: requirements-to-freeze.txt
• Call: pip freeze -r requirements-to-freeze.txt > requirements.txt
• Call: tox
• Ready to go

Contributing

First make sure to read our general contribution guidelines.

License

Copyright (c) 2020 the original author or authors. DO NOT ALTER OR REMOVE COPYRIGHT NOTICES.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.