Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thanatisia/py-utilities

An all-in-one package containing a collection of self-implemented Python packages/frameworks/libraries (the following will collectively be known as 'library') such that you can add this into a project as a submodule and you can import the libraries directly
https://github.com/thanatisia/py-utilities

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/thanatisia/py-utilities
Owner: Thanatisia
License: mit
Created: 2023-12-21T14:10:10.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-06-08T15:14:38.000Z (5 months ago)
Last Synced: 2024-06-08T16:33:39.480Z (5 months ago)
Language: Python
Size: 7.66 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOGS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# My All-in-One library/package/framework collection for Python

## Information

### Background Summary
+ A python one-stop-shop mono-repo containing various useful python utilities, packages/frameworks/libraries that you can just install and use

### Project
+ Current Version: v0.5.4

## Setup
### Dependencies
+ python3
+ pip

### Pre-Requisites
- Generate Python Virtual Environment
- Create Virtual Environment
```bash
python3 -m venv [virtual-environment-name]
```
- Chroot into Virtual Environment
- Linux
```bash
. [virtual-environment-name]/bin/activate
```
- Windows
```bash
.\[virtual-environment-name]\Scripts\activate
```

### Installing
- Using python pip
- Install git repository
```bash
python3 -m pip install git+https://github.com/Thanatisia/py-utilities{@[branch-tag-name]}
```
- Using requirements.txt
- Create 'requirements.txt'
```
pyutils @ git+https://github.com/Thanatisia/py-utilities{@[branch-tag-name]}
```
- Install pip packages using 'requirements.txt'
```bash
python3 -m pip install -Ur requirements.txt
```

- Manually via cloning
- Clone git repository
```bash
git clone https://github.com/Thanatisia/py-utilities
```
- Change directory into project root
```bash
cd py-utilities
```
- (Optional) Install python dependencies
```bash
python3 -m pip install -Ur requirements.txt
```
- Install package as development mode
```bash
pip install .
```
- (Optional) Uninstall package
```bash
pip uninstall py-utilities
```

### Embedding library in your own project
- Change directory into your project root containing the git folder
```console
cd [project-root]
```

- Importing as a git submodule
```console
git submodule add https://github.com/Thanatisia/py-utilities
```

### Following usage setup
- Initialize git submodule databases
```console
git submodule --init
```

- Clone all submodules in the submodule database/list
```console
git submodule update --init
```

## Documentations

### Demo
+ Please refer to [demo.md](demo.md) for all demo animation GIFs and examples

### Generating Demo animation gif
- Using Makefile
- Pre-Requisites
- Optionals
+ Edit the command by prepending with 'command="[new-command-here]""
- Notes
+ Set 'command=""' to enter into terminal session recording for manual shell input, allowing for manual user input
```bash
make -f docs/documentation.gif record convert
```

## Wiki
### Project Structure
- root/
- src/
- pyutils/
- decorators/ : Place all decorator wrapper libraries here
- frameworks/ : Place all frameworks and multi-library files here
- libraries/ : Place all standalone libraries/modules and classes here
- scripts/ : Place all scripts/CLI utilities here

## Resources

## References

## Remarks