ORIGIN PROJECT

---

Cloneable referential to initialize a Python project based on this template with the best practice. This is a pre-configured and read-to-used project to create deployable python libraries or application much more easily.

Table of Contents

• Description
• Installation
  • For Linux
  • For Windows
• Usage
• Features
• Tests
• To contribute
• Licence
• Contact

Description

My Python project is a simple application that allows users to create, read, update and delete the tasks. It is designed to be easy to use and expand.

Installation

To install the project, make sure you have Python 3.8 or later version and pip installed on your machine. And then run the following command lines.

For Linux

git clone git@github.com:mokira3d48/PyOrigin.git my_project;
cd my_project;
sudo rm -r .git;
git init;  # To create a new instance of git repository

And then,

1. sudo apt install cmake python3-venv Install Cmake and Virtual env;
2. python3 -m venv .venv create a virtual env into directory named env;
3. source .venv/bin/activate activate the virtual environment named .venv;
4. make install install the requirements of this package;
5. pip install -e . install the package in dev mode in virtual environment;
6. make test run the unit test scripts located at tests directory;
7. make run run script located at src/package_name/__main__.py.
8. Or Run mycmd as a command line to run src/package_name/__main__.py.

For Windows

git clone git@github.com:mokira3d48/PyOrigin.git my_project

cd my_project

And then, delete the hidden directory named .git located at the root of the directory project.

And then,

1. Install python for windows;
2. Open your command prompt;
3. Run python -m venv .venv to create a virtual env into directory named .venv; 4 . Run .venv\Scripts\activate to activate the virtual environment;
4. Run pip install -r requirements.txt to install the requirements of this package or project;
5. Run pip install -e . install the package in dev mode in virtual environment;
6. Run python -m package_name to run main script located at src\package_name\__main__.py. Or Run mycmd as a command line to run src\package_name\__main__.py and start the application.

---

Usage

Here is an example how to add a new task:

from package_name.utils import get_file_paths_list


def main():
    """Main function
    """
    file_paths = get_file_paths_list('./')
    file_paths = sorted(file_paths)
    print("List of file paths:", file_paths)


if __name__ == '__main__':
    main()

Features

• Add tasks.
• Mark tasks as complete.
• Delete tasks.
• Show all the tasks.

Tests

To execute the unittest, make sure you have pytest package installed, and then run the following command line:

make test 

or

pytest

---

To contribute

Contributions are welcome! Please follow these steps:

1. Create a new branch for your feature (git checkout -b feature/my-feature);
2. Commit your changes (git commit -m 'Adding a new feature');
3. Push toward the branch (git push origin feature/my-feature);
4. Create a new Pull Request or Merge Request.

Licence

This project is licensed under the MIT License. See the file LICENSE for more details, contact me please.

Contact

For your question or suggestion, contact me please:

• Name : Your name (Doctor Mokira)
• Email : Your email address (dr.mokira@gmail.com)
• GitHub : Your GitHub or Gitlab profile