From c4efe9a684a924d0d78dd5b2300bb821af1bc8bf Mon Sep 17 00:00:00 2001 From: Jose Date: Sun, 2 Feb 2025 22:20:09 +0100 Subject: [PATCH] modified: LICENSE modified: README.md new file: requirements.txt --- LICENSE | 7 ++++++- README.md | 37 +++++++++++++++++++++++++++++++++---- requirements.txt | 18 ++++++++++++++++++ 3 files changed, 57 insertions(+), 5 deletions(-) create mode 100644 requirements.txt diff --git a/LICENSE b/LICENSE index f76c13b..943e11a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,8 @@ Copyright (c) 2025 Jose -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR +PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 6ce2244..d3e5fb0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,35 @@ -<<<<<<< HEAD # python_template_repository -======= -# python template repository ->>>>>>> 3cfcee4 (Initial commit) + +This is a template repository for Python projects. It includes basic files and directories such as `setup.py`, `requirements.txt`, and a README file. +To use this template, you can clone the repository to your local machine using the following command: +git clone https://repo.piave7.duckdns.org/Jose/python_template + +Once you have cloned the repository, you can navigate into the project directory and start working on your Python project. You can install the required dependencies by running the following command: + +pip install -r requirements.txt + +You can also create a virtual environment for your project using the following command: + +python -m venv venv + +Once you have created the virtual environment, you can activate it using the appropriate command for your operating system. For example, on Windows, you can run the following command: + +venv\Scripts\activate + +On macOS and Linux, you can run the following command: + +source venv/bin/activate + +You can now start working on your Python project by editing the files in the `src` directory. Once you are done with your work, you can deactivate the virtual environment using the following command: + +deactivate + +To build the project, you can run the following command: + +python setup.py sdist bdist_wheel + +This will create a source distribution and a wheel distribution of your project. +To install the project from the source distribution, you can run the following command: + +pip install dist/python_template-0.1.0.tar.gz diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..4521205 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,18 @@ +# requirements.txt + +# Specify the package name and version +# Format: package==version + +# Example packages +# numpy==1.21.2 +# pandas==1.3.3 +# requests==2.26.0 +# flask==2.0.1 + +# You can also specify a range of versions +# Example: +# Django>=3.2,<4.0 + +# If you have a package that can be any version, just list the name +# Example: +# somepackage \ No newline at end of file