Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Minor changes to README.md and DEVELOPMENT.md #16

Merged
davidbrownell merged 1 commit into from
Mar 24, 2024
Merged

Minor changes to README.md and DEVELOPMENT.md #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Python Project Bootstrapper

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.
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.

## Generated Content

Expand All @@ -22,6 +22,8 @@ Automated tests that exercise functionality defined within your package. There s

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`.

Visit [PythonBootstrapper](https://github.com/davidbrownell/PythonBootstrapper) for more information about these files.

### `Build.py`

The entry point for local development activities for your repository. Run `python Build.py --help` for more information about this script.
Expand Down
36 changes: 16 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# PythonProjectBootstrapper

[![CI](https://github.com/gt-sse-center/PythonProjectBootstrapper/actions/workflows/standard.yaml/badge.svg?event=push)](https://github.com/gt-sse-center/PythonProjectBootstrapper/actions/workflows/standard.yaml)
[![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/davidbrownell/2f9d770d13e3a148424f374f74d41f4b/raw/PythonProjectBootstrapper_coverage.json)](https://github.com/gt-sse-center/PythonProjectBootstrapper/actions)
[![License](https://img.shields.io/github/license/gt-sse-center/PythonProjectBootstrapper?color=dark-green)](https://github.com/gt-sse-center/PythonProjectBootstrapper/blob/master/LICENSE.txt)
Expand All @@ -9,9 +7,7 @@
[![PyPI - Downloads](https://img.shields.io/pypi/dm/PythonProjectBootstrapper)](https://pypistats.org/packages/pythonprojectbootstrapper)


# PythonProjectBootstrapper

Tools that help in the creation of python projects.
Tool that helps in the creation of python projects.

### Quick Start

Expand All @@ -24,7 +20,7 @@ Tools that help in the creation of python projects.

#### Functionality Provided in Generated Projects

- Simple local development through `Build.py` (see [Local Development](#local-development))
- Simple local development through `Build.py` (see [Local Development](#local-development) for more information)
- Python bootstrapping via [PythonBootstrapper](https://github.com/davidbrownell/PythonBootstrapper)
- Source code formatting via [black](https://github.com/psf/black)
- Static source analysis via [pylint](https://github.com/pylint-dev/pylint)
Expand All @@ -39,7 +35,7 @@ Tools that help in the creation of python projects.

#### Project Content Customization

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.
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.

### How to use PythonProjectBootstrapper

Expand All @@ -58,19 +54,19 @@ From a terminal window, run one of the commands below. You will be asked a serie
<td><code>PythonProjectBootstrapper package &lt;output_dir&gt;</code></td>
<td>
<pre style="background-color: black; color: #AAAAAA; font-size: .75em">
┌──────────────────────────────────────────────────────────────────────────────── Python Package ─────────────────────────────────────────────────────────────────────────────────┐
│ │
│ 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 │
│ reproducibility of all commits (which is especially useful for scientific software). │
│ │
│ 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 │
│ solutions (GitHub, PyPi, etc.). │
│ │
│ The entire process should take about 20 minutes to complete. │
│ │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
┌──────────────────────────────────────────────────────────────────────────────── Python Package ─────────────────────────────────────────────────────────────────────────────────┐
│ │
│ 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 │
│ reproducibility of all commits (which is especially useful for scientific software). │
│ │
│ 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 │
│ solutions (GitHub, PyPi, etc.). │
│ │
│ The entire process should take about 20 minutes to complete. │
│ │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
&nbsp;
Enter 'yes' to continue or 'no' to exit:
Enter 'yes' to continue or 'no' to exit:
</pre>
</td>
</tr>
Expand Down Expand Up @@ -154,7 +150,7 @@ Follow these steps to prepare the repository for local development activities.

## Similar Tools

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.
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.

| Tool | Description |
| --- | --- |
Expand Down