You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 29, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Python Project Bootstrapper
2
2
3
-
This page contains information associated with the content generated by `PythonProjectBootstrapper`. Please see [README.md](https://github.com/gt-sse-center/PythonProjectBootstrapper) for information about `PythonProjectBootstrapper` itself.
3
+
This page contains information associated with the content generated by `PythonProjectBootstrapper`. Please see [README.md](https://github.com/gt-sse-center/PythonProjectBootstrapper/blob/main/README.md) for information about `PythonProjectBootstrapper` itself.
4
4
5
5
## Generated Content
6
6
@@ -22,6 +22,8 @@ Automated tests that exercise functionality defined within your package. There s
22
22
23
23
Script that prepares your repository for development within the local environment. This script installs python (if necessary), creates a virtual python environment, and installs the python dependencies defined in `pyproject.toml`. In addition, it creates the files `Activate.sh` / `Activate.cmd` and `Deactivate.sh` / `Deactivate.cmd`.
24
24
25
+
Visit [PythonBootstrapper](https://github.com/davidbrownell/PythonBootstrapper) for more information about these files.
26
+
25
27
### `Build.py`
26
28
27
29
The entry point for local development activities for your repository. Run `python Build.py --help` for more information about this script.
Tools that help in the creation of python projects.
10
+
Tool that helps in the creation of python projects.
15
11
16
12
### Quick Start
17
13
@@ -24,7 +20,7 @@ Tools that help in the creation of python projects.
24
20
25
21
#### Functionality Provided in Generated Projects
26
22
27
-
- Simple local development through `Build.py` (see [Local Development](#local-development))
23
+
- Simple local development through `Build.py` (see [Local Development](#local-development) for more information)
28
24
- Python bootstrapping via [PythonBootstrapper](https://github.com/davidbrownell/PythonBootstrapper)
29
25
- Source code formatting via [black](https://github.com/psf/black)
30
26
- Static source analysis via [pylint](https://github.com/pylint-dev/pylint)
@@ -39,7 +35,7 @@ Tools that help in the creation of python projects.
39
35
40
36
#### Project Content Customization
41
37
42
-
Please see [DEVELOPMENT.md](https://github.com/gt-sse-center/PythonProjectBootstrapper/DEVELOPMENT.md) for information on the generated content and how to make common modifications to that content.
38
+
Please see [DEVELOPMENT.md](https://github.com/gt-sse-center/PythonProjectBootstrapper/blob/main/DEVELOPMENT.md) for information on the generated content and how to make common modifications to that content.
43
39
44
40
### How to use PythonProjectBootstrapper
45
41
@@ -58,19 +54,19 @@ From a terminal window, run one of the commands below. You will be asked a serie
│ This project creates a Python package hosted on GitHub that uploads a Python wheel to PyPi. It also includes opt-in functionality to create docker images that ensure the exact │
64
-
│ reproducibility of all commits (which is especially useful for scientific software). │
65
-
│ │
66
-
│ If you continue, you will be asked a series of questions about your project and given step-by-step instructions on how to set up your project so that it works with 3rd party │
67
-
│ solutions (GitHub, PyPi, etc.). │
68
-
│ │
69
-
│ The entire process should take about 20 minutes to complete. │
│ This project creates a Python package hosted on GitHub that uploads a Python wheel to PyPi. It also includes opt-in functionality to create docker images that ensure the exact │
60
+
│ reproducibility of all commits (which is especially useful for scientific software). │
61
+
│ │
62
+
│ If you continue, you will be asked a series of questions about your project and given step-by-step instructions on how to set up your project so that it works with 3rd party │
63
+
│ solutions (GitHub, PyPi, etc.). │
64
+
│ │
65
+
│ The entire process should take about 20 minutes to complete. │
@@ -154,7 +150,7 @@ Follow these steps to prepare the repository for local development activities.
154
150
155
151
## Similar Tools
156
152
157
-
There are other tools available that offer similar functionality, each that emphasizes different domains, conventions, or workflows. They are listed here in the event that one of them is a better fit for the specifics of your scenario.
153
+
There are other tools available that offer similar functionality, each emphasizing different domains, conventions, or workflows. They are listed here in the event that one of them is a better fit for the specifics of your scenario.
0 commit comments