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 `~/`
carcass

# 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: josh.rickard@letsautomate.it

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
   Exceptions
   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
 ┃ ┃ ┃ ┗ 📜api.py
 ┃ ┃ ┣ 📂frontend
 ┃ ┃ ┃ ┗ 📜frontend.py
 ┃ ┃ ┣ 📂templates
 ┃ ┃ ┃ ┣ 📜404.html
 ┃ ┃ ┃ ┣ 📜500.html
 ┃ ┃ ┃ ┣ 📜base.html
 ┃ ┃ ┃ ┗ 📜index.html
 ┃ ┃ ┣ 📜__init__.py
 ┃ ┃ ┗ 📜config.py
 ┃ ┣ 📂utils
 ┃ ┃ ┣ 📜__init__.py
 ┃ ┃ ┣ 📜exceptions.py
 ┃ ┃ ┣ 📜logger.py
 ┃ ┃ ┗ 📜version.py
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜__main__.py
 ┃ ┣ 📜graphconnector.py
 ┃ ┗ 📜test package.py
 ┣ 📜.gitignore
 ┣ 📜CONTRIBUTING.md
 ┣ 📜Dockerfile
 ┣ 📜LICENSE.md
 ┣ 📜README.md
 ┣ 📜docker-compose.yml
 ┣ 📜logger.yml
 ┣ 📜requirements.txt
 ┗ 📜setup.py

Installation

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

pip install carcass
git clone git@github.com:MSAdministrator/carcass.git
cd carcass
pip install -r requirements.txt

Development

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

Say what the step will be

pip install --user pipenv
git clone git@github.com:MSAdministrator/carcass.git
cd carcass

Next, install and setup a virtual environment:

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

Running the tests

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

pip install --user pipenv
git clone git@github.com:MSAdministrator/carcass.git
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 README.md template

def test_creation_of_readme_template_exists(carcass_fixture):
    '''
    Testing the creation of README.md 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']), 'README.md'))

Upcoming Additions

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

Contributing

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

Versioning

We use SemVer for versioning.

Authors

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

License

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.

Files for carcass, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size carcass-1.1.0-py2-none-any.whl (24.6 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size carcass-1.1.0-py3-none-any.whl (24.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size carcass-1.1.0.tar.gz (18.6 kB) File type Source Python version None Upload date Hashes View

Supported by

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