GitLocker: The Coding Marketplace

Description:

oplc 0.0.1

🛑 We are building the basic architecture of oplc, so stay tuned for the initial release.

oplc

A simple way to use langchain framework.

Quick Start
pip install oplc

Then we can use the ability of LangChain alsf to chat like promptulate
import oplc

oplc.chat()

Development in local environment
Conda package manager is recommended. Create a conda environment.
conda create -n oplc python==3.10

Activate conda environment and install poetry
conda activate oplc
pip install poetry

Makefile usage
Makefile contains a lot of functions for faster development.

Install all dependencies and pre-commit hooks

Install requirements:
make install

Pre-commit hooks coulb be installed after git init via
make pre-commit-install

Codestyle and type checks

Automatic formatting uses ruff.
make polish-codestyle

# or use synonym
make formatting

Codestyle checks only, without rewriting files:
make check-codestyle

Note: check-codestyle uses ruff and darglint library

Code security

If this command is not selected during installation, it cannnot be used.

make check-safety

This command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.
make check-safety

Tests with coverage badges

Run pytest
make test

All linters

Of course there is a command to run all linters in one:
make lint

the same as:
make check-codestyle && make test && make check-safety

Docker

make docker-build

which is equivalent to:
make docker-build VERSION=latest

Remove docker image with
make docker-remove

More information about docker.

Cleanup

Delete pycache files
make pycache-remove

Remove package build
make build-remove

Delete .DS_STORE files
make dsstore-remove

Remove .mypycache
make mypycache-remove

Or to remove all above run:
make cleanup

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.
📃 Citation
@misc{aslf,
author = {aslf},
title = {A simple way to use langchain framework.},
year = {2024},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/Undertone0809/aslf}}
}

Credits
This project was generated with P3G