# Docs Structure Guide # Rst docs - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html # # 1. Place docs in folders under source for different sections # 2. Link them by adding individual index files in each section # to the main index, and then files for each section to their # respective index files. # 3. Use .. include statements to include other .rst files # or part of them, or use hyperlinks to a section of the docs, # to get rid of repetition. # https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment # # Note: Replace these guide/placeholder docs

A Simple Python Project Skeleton

This repo attempts to standardize our python repositories using modern python packaging and configuration techniques. Using this blog post as inspiration, this repository will serve as the base for all new python projects and will be adopted to all our existing ones as well.

Usage

A brand new project

git init my-new-repo
cd my-new-repo
git pull git@github.com:nexB/skeleton

# Create the new repo on GitHub, then update your remote
git remote set-url origin git@github.com:nexB/your-new-repo.git

From here, you can make the appropriate changes to the files for your specific project.

Update an existing project

cd my-existing-project
git remote add skeleton git@github.com:nexB/skeleton
git fetch skeleton
git merge skeleton/main --allow-unrelated-histories

This is also the workflow to use when updating the skeleton files in any given repository.