File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11A Simple Python Project Skeleton
22================================
3- Note: configure script requires src/ directory to run correctly.
3+ This repo attempts to standardize our python repositories using modern python
4+ packaging and configuration techniques. Using this `blog post `_ as inspiration, this
5+ repository will serve as the base for all new python projects and will be adopted to all
6+ our existing ones as well.
7+
8+ .. _blog post : https://blog.jaraco.com/a-project-skeleton-for-python-projects/
9+
10+ Usage
11+ =====
12+ A brand new project
13+ -------------------
14+ .. code-block :: bash
15+
16+ git init my-new-repo
17+ cd my-new-repo
18+ git pull git@github.com:nexB/skeleton
19+
20+ From here, you can make the appropriate changes to the files for your specific project.
21+
22+ Update an existing project
23+ ---------------------------
24+ .. code-block :: bash
25+
26+ cd my-existing-project
27+ git remote add skeleton git@github.com:nexB/skeleton
28+ git fetch skeleton
29+ git merge skeleton --allow-unrelated-histories
30+
31+ This is also the workflow to use when updating the skeleton files in any given repository.
You can’t perform that action at this time.
0 commit comments