https://github.com/ofabel/pytm-skeleton
Skeleton for a new Python Tool Manager exercise.
https://github.com/ofabel/pytm-skeleton
Last synced: 8 months ago
JSON representation
Skeleton for a new Python Tool Manager exercise.
- Host: GitHub
- URL: https://github.com/ofabel/pytm-skeleton
- Owner: ofabel
- License: mit
- Created: 2023-08-27T12:13:21.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-27T13:26:41.000Z (almost 3 years ago)
- Last Synced: 2025-06-01T05:17:59.063Z (about 1 year ago)
- Language: Python
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pytm-skeleton
This repository contains a skeleton to create a new exercise for the _Python Tool Manager_.
You can find more information on the _Python Tool Manager_ in the
corresponding [documentation on GitHub](https://ofabel.github.io/pytm-bootstrap/).
## Usage
First, you need to create a
new [GitHub repository from this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
and clone the just created repository on your computer.
### Create a Virtual Python Environment
Open a terminal window, navigate to the cloned or downloaded repository folder and execute the following command:
```shell
python -m venv venv
```
This will create a new `venv` folder, containing the virtual environment. It's mandatory, that folder's name is `venv`.
### Install the Dependencies
Open a terminal window, navigate to the cloned or downloaded repository
folder, [activate the virtual environment](https://docs.python.org/3/library/venv.html#how-venvs-work) and execute the
following command:
```shell
pip install -r requirements.txt
```
### Run an Exercise
To run an exercise you need to open a terminal window, navigate to the cloned or downloaded repository folder and
activate the virtual environment. Now, navigate to the desired exercise folder and execute the following command:
```shell
flask run --debug
```
## Things Left To Do
* [ ] Change this [Readme.md](./README.md) file according to your project.
* [ ] Change the [license](./LICENSE) according to your needs.
* [ ] Add your additional requirements to the [requirements.txt](requirements.txt) file.
* [ ] Keep the [changelog](./CHANGELOG.md) up to date.