Skip to main content

A Python package to generate python package scaffolding based on best practices

Project description

Python package

carcass is a Python command line tool to generate python package scaffolding based on best practices

Getting Started

To use carcass you can run it directly. Since carcass is mainly considered a command line tool, once installed, you run it directly:

# Default generated package path is the current users directory `~/`

# Provide an alternate path location 
carcass -P ~/my_packages/path
carcass --path ~/my_packages/path

Once you run carcass you will be prompted to provide answers to the following questions:

Enter your package name: mytestpackage
Enter your first and last name: Josh Rickard
Enter your GitHub user name: MSAdministrator
Enter your email address:

Additionally, you have additional package options that you can select all, some, or none of them using your space key.

Currently, carcass supports the following additional package options. I will continue to add additional options as needed/wanted:

Please select all package options which you want carcass to generate

 * Logger
   Microsoft Graph OAuth2
   Flask App

Package Template Structure

carcass generates packages based on your provided inputs as well as selected options during creation.

Below is the structure outline for a template python package generated by carcass with all options selected:

📦test package
 ┣ 📂test package
 ┃ ┣ 📂app
 ┃ ┃ ┣ 📂api
 ┃ ┃ ┃ ┗ 📜
 ┃ ┃ ┣ 📂frontend
 ┃ ┃ ┃ ┗ 📜
 ┃ ┃ ┣ 📂templates
 ┃ ┃ ┃ ┣ 📜404.html
 ┃ ┃ ┃ ┣ 📜500.html
 ┃ ┃ ┃ ┣ 📜base.html
 ┃ ┃ ┃ ┗ 📜index.html
 ┃ ┃ ┣ 📜
 ┃ ┃ ┗ 📜
 ┃ ┣ 📂utils
 ┃ ┃ ┣ 📜
 ┃ ┃ ┣ 📜
 ┃ ┃ ┣ 📜
 ┃ ┃ ┗ 📜
 ┃ ┣ 📜
 ┃ ┣ 📜
 ┃ ┣ 📜
 ┃ ┗ 📜test
 ┣ 📜.gitignore
 ┣ 📜
 ┣ 📜Dockerfile
 ┣ 📜
 ┣ 📜
 ┣ 📜docker-compose.yml
 ┣ 📜logger.yml
 ┣ 📜requirements.txt
 ┗ 📜


In order to use carcass you can install it via pip or clone this repository.

pip install carcass
git clone
cd carcass
pip install -r requirements.txt


To get a development env running, you can clone this repository

Say what the step will be

pip install --user pipenv
git clone
cd carcass

Next, install and setup a virtual environment:

pip install virtualenv
virtualenv venv
pip install -r requirements.txt

Running the tests

To run unit tests, you will need to clone this repository:

pip install --user pipenv
git clone
cd carcass

Next, you run tests using the following command:

python -m pytest 

Break down into end to end tests

Tests within this package test to ensure that the correct files are being created as requested as well as some tests check the contents of the template files:

# testing the creation of a template

def test_creation_of_readme_template_exists(carcass_fixture):
    Testing the creation of template file
    carcass = carcass_fixture.create_package(pytest.configuration['package_path'], pytest.package)
    assert os.path.exists(os.path.join(str(pytest.configuration['package_path']), ''))

Upcoming Additions

[x] Add Flask application template [] Add Database templates [] Add Celery worker templates [] Add Redis templates [] Add GraphQL templates


Please read for details on our code of conduct, and the process for submitting pull requests to us.


We use SemVer for versioning.


See also the list of contributors who participated in this project.


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

Project details

Download files

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

Source Distribution

carcass-1.2.0.tar.gz (20.3 kB view hashes)

Uploaded source

Built Distribution

carcass-1.2.0-py3-none-any.whl (28.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page