Skip to main content

Automation Mojo Landscaping 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

  • Update the LICENSE.txt file with your copyright information and license.

  • 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_landscaping-1.3.6.tar.gz (37.2 kB view hashes)

Uploaded Source

Built Distribution

mojo_landscaping-1.3.6-py3-none-any.whl (63.2 kB view hashes)

Uploaded Python 3

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