Skip to main content

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

pcao

Build status Python Version Dependencies Status

Code style: ruff Pre-commit Semantic Versions License Coverage Report

A simple way to use langchain framework.

Quick Start

pip install clerk

Development in local environment

Conda package manager is recommended. Create a conda environment.

conda create -n clerk python==3.10

Activate conda environment and install poetry

conda activate clerk
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

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

Credits 🚀 Your next Python package needs a bleeding-edge project structure.

This project was generated with P3G

Metadata

Release files for python-clerk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-clerk 0.0.1
File Size Uploaded
python_clerk-0.0.1.tar.gz 4.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for python-clerk 0.0.1
File Interpreter ABI Platform
python_clerk-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 8.6 kB

Release files / python_clerk-0.0.1.tar.gz

Download URL python_clerk-0.0.1.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
86057fa3cdd9f9814021eba89b8b39f8f4fdb3ce033fc54d50780f10584ab3c9
BLAKE2b-256 checksum
How to use checksums
8e651dafacceaf29622f43f6b988126d6f75df51d0f77234c7ddb1bec371c598
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.0 CPython/3.11.5 Windows/10

Release files / python_clerk-0.0.1-py3-none-any.whl

Download URL python_clerk-0.0.1-py3-none-any.whl
Size 4.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
245df0e6fdbd236d11451b48f2c6c2c37bd6d2fd05d70df6f2de5eb803c226e3
BLAKE2b-256 checksum
How to use checksums
3579ad63498fb9ba9fa5bdef08b43fafa8385384a533309ce80d1d3ead6a14e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.7.0 CPython/3.11.5 Windows/10

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page