https://github.com/buckley-w-david/testmod
Module to demonstrate the use of setuptools
https://github.com/buckley-w-david/testmod
Last synced: 7 months ago
JSON representation
Module to demonstrate the use of setuptools
- Host: GitHub
- URL: https://github.com/buckley-w-david/testmod
- Owner: buckley-w-david
- License: mit
- Created: 2018-01-21T15:55:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T00:57:36.000Z (almost 3 years ago)
- Last Synced: 2025-01-28T02:11:46.120Z (9 months ago)
- Language: Python
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# testmod
Module to demonstrate the use of setuptools
# Installation Instructions
```
$ git clone https://github.com/buckley-w-david/testmod.git
$ cd testmod
$ python -m venv env # Create a virtual environment (not technically necessary but good practice)
$ source env/bin/activate
$ pip install -e .
```
The `-e` option in the install command is optional, it installs the package in editable mode, meaning if you make a change to the source it will be reflected in the package without needing to re-install it.
You can provide `pip install` with any path to a valid python package, this examle simply uses one in the current directory.
# Usage Instructions
```
$ python
>> from testmod import functions
>> functions.add(3, 2)
5
```