Skip to main content

Automation Mojo Configuration Package

Project description

python-package-template

This is a template repository that can be used to quickly create a python package project.

Features of this Template

  • Machine Setup

  • Virtual Environment Setup (Poetry)

  • PyPi Publishing

  • Sphinx Documentation

How to Use This Template

  • Click the ‘Use this template’ button

  • Fill in the information to create your repository

  • Checkout your new repository

  • Change the following in ‘repository-config.ini’

    1. ‘PROJECT NAME’

    2. ‘REPOSITORY_NAME’

  • If you have machine dependencies to add, put them in ‘setup-ubuntu-machine’

  • Modify the pyproject.toml file with the correct package-name, author, publishing information, etc.

  • Rename the VSCODE workspace file ‘mv workspaces/default-workspace.template workspaces/(project name).template’

  • Replace the README.rst file with your own README

  • Add your dependencies with python poetry ‘poetry add (dependency name)’

  • Drop your package code in ‘source/packages’

  • Modify the name of your package root in ‘pyproject.toml’

    1. ‘packages = [{include=”(root folder name)”, from=”source/packages”}]’

Code Organization

  • .vscode - Common tasks

  • development - This is where the runtime environment scripts are located

  • repository-setup - Scripts for homing your repository and to your checkout and machine setup

  • userguide - Where you put your user guide

  • source/packages - Put your root folder here ‘source/packages/(root-module-folder)’

  • source/sphinx - This is the Sphinx documentation folder

  • workspaces - This is where you add VSCode workspaces templates and where workspaces show up when homed.

References

  • User Guide <userguide/userguide.rst>

  • Coding Standards <userguide/10-00-coding-standards.rst>

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

mojo_config-0.0.31.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

mojo_config-0.0.31-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file mojo_config-0.0.31.tar.gz.

File metadata

  • Download URL: mojo_config-0.0.31.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.0 CPython/3.10.6 Linux/6.2.0-37-generic

File hashes

Hashes for mojo_config-0.0.31.tar.gz
Algorithm Hash digest
SHA256 94ce6ef54e99a58f7e50d7a2d4c11323a4b54639f872253c9c52f37d7ab164aa
MD5 1d0f241b756cb2b4ac1ee889c26a5324
BLAKE2b-256 1060673a5a676d115ef7b7de47fadd99198d3bcf8472a622bad11030f53e3e43

See more details on using hashes here.

File details

Details for the file mojo_config-0.0.31-py3-none-any.whl.

File metadata

  • Download URL: mojo_config-0.0.31-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.0 CPython/3.10.6 Linux/6.2.0-37-generic

File hashes

Hashes for mojo_config-0.0.31-py3-none-any.whl
Algorithm Hash digest
SHA256 633b513c86353e3a62f26a755d980c0822e97668edfbcab0e9c4e9467f1a3c09
MD5 4da0f0d5c2b5524f549e6424dbb65544
BLAKE2b-256 601c0cf8f2050b2163220a4808529da4475655b96b2b7e6f6a2013050191ffca

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page