> 🛑 We are building the basic architecture of pyclerk, so stay tuned for the initial release.
# pcao
<div align="center">
[](https://github.com/Undertone0809/aslf/actions?query=workflow%3Abuild)
[](https://pypi.org/project/aslf/)
[](https://github.com/Undertone0809/aslf/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/astral-sh/ruff)
[](https://github.com/Undertone0809/aslf/blob/main/.pre-commit-config.yaml)
[](https://github.com/Undertone0809/aslf/releases)
[](https://github.com/Undertone0809/aslf/blob/main/LICENSE)
A simple way to use langchain framework.
</div>
## Quick Start
```shell
pip install clerk
```
## Development in local environment
Conda package manager is recommended. Create a conda environment.
```bash
conda create -n clerk python==3.10
```
Activate conda environment and install poetry
```bash
conda activate clerk
pip install poetry
```
### Makefile usage
[`Makefile`](https://github.com/Undertone0809/aslf/blob/main/Makefile) contains a lot of functions for faster development.
<details>
<summary>Install all dependencies and pre-commit hooks</summary>
<p>
Install requirements:
```bash
make install
```
Pre-commit hooks coulb be installed after `git init` via
```bash
make pre-commit-install
```
</p>
</details>
<details>
<summary>Codestyle and type checks</summary>
<p>
Automatic formatting uses `ruff`.
```bash
make polish-codestyle
# or use synonym
make formatting
```
Codestyle checks only, without rewriting files:
```bash
make check-codestyle
```
> Note: `check-codestyle` uses `ruff` and `darglint` library
</p>
</details>
<details>
<summary>Code security</summary>
<p>
> If this command is not selected during installation, it cannnot be used.
```bash
make check-safety
```
This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.
```bash
make check-safety
```
</p>
</details>
<details>
<summary>Tests with coverage badges</summary>
<p>
Run `pytest`
```bash
make test
```
</p>
</details>
<details>
<summary>All linters</summary>
<p>
Of course there is a command to run all linters in one:
```bash
make lint
```
the same as:
```bash
make check-codestyle && make test && make check-safety
```
</p>
</details>
<details>
<summary>Docker</summary>
<p>
```bash
make docker-build
```
which is equivalent to:
```bash
make docker-build VERSION=latest
```
Remove docker image with
```bash
make docker-remove
```
More information [about docker](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/docker).
</p>
</details>
<details>
<summary>Cleanup</summary>
<p>
Delete pycache files
```bash
make pycache-remove
```
Remove package build
```bash
make build-remove
```
Delete .DS_STORE files
```bash
make dsstore-remove
```
Remove .mypycache
```bash
make mypycache-remove
```
Or to remove all above run:
```bash
make cleanup
```
</p>
</details>
## 🛡 License
[](https://github.com/Undertone0809/aslf/blob/main/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/Undertone0809/aslf/blob/main/LICENSE) for more details.
## Credits [](https://github.com/Undertone0809/python-package-template)
This project was generated with [P3G](https://github.com/Undertone0809/P3G)
Raw data
{
"_id": null,
"home_page": "https://github.com/Undertone0809/pyclerk",
"name": "python-clerk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8.0",
"maintainer_email": null,
"keywords": "pyclerk, clerk",
"author": "Zeeland",
"author_email": "zeeland4work@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8e/65/1dafacceaf29622f43f6b988126d6f75df51d0f77234c7ddb1bec371c598/python_clerk-0.0.1.tar.gz",
"platform": null,
"description": "> \ud83d\uded1 We are building the basic architecture of pyclerk, so stay tuned for the initial release.\n\n# pcao\n\n<div align=\"center\">\n\n[](https://github.com/Undertone0809/aslf/actions?query=workflow%3Abuild)\n[](https://pypi.org/project/aslf/)\n[](https://github.com/Undertone0809/aslf/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)\n\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/Undertone0809/aslf/blob/main/.pre-commit-config.yaml)\n[](https://github.com/Undertone0809/aslf/releases)\n[](https://github.com/Undertone0809/aslf/blob/main/LICENSE)\n\n\nA simple way to use langchain framework.\n\n</div>\n\n\n## Quick Start\n\n```shell\npip install clerk\n```\n\n\n\n## Development in local environment\n\nConda package manager is recommended. Create a conda environment.\n\n```bash\nconda create -n clerk python==3.10\n```\n\nActivate conda environment and install poetry\n\n```bash\nconda activate clerk\npip install poetry\n```\n\n\n\n### Makefile usage\n\n[`Makefile`](https://github.com/Undertone0809/aslf/blob/main/Makefile) contains a lot of functions for faster development.\n\n\n<details>\n<summary>Install all dependencies and pre-commit hooks</summary>\n<p>\n\nInstall requirements:\n\n```bash\nmake install\n```\n\nPre-commit hooks coulb be installed after `git init` via\n\n```bash\nmake pre-commit-install\n```\n\n</p>\n</details>\n\n<details>\n<summary>Codestyle and type checks</summary>\n<p>\n\nAutomatic formatting uses `ruff`.\n\n```bash\nmake polish-codestyle\n\n# or use synonym\nmake formatting\n```\n\nCodestyle checks only, without rewriting files:\n\n```bash\nmake check-codestyle\n```\n\n> Note: `check-codestyle` uses `ruff` and `darglint` library\n\n</p>\n</details>\n\n<details>\n<summary>Code security</summary>\n<p>\n\n> If this command is not selected during installation, it cannnot be used.\n\n```bash\nmake check-safety\n```\n\nThis command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.\n\n```bash\nmake check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>Tests with coverage badges</summary>\n<p>\n\nRun `pytest`\n\n```bash\nmake test\n```\n\n</p>\n</details>\n\n<details>\n<summary>All linters</summary>\n<p>\n\nOf course there is a command to run all linters in one:\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake check-codestyle && make test && make check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>Docker</summary>\n<p>\n\n```bash\nmake docker-build\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker-build VERSION=latest\n```\n\nRemove docker image with\n\n```bash\nmake docker-remove\n```\n\nMore information [about docker](https://github.com/Undertone0809/python-package-template/tree/main/%7B%7B%20cookiecutter.project_name%20%7D%7D/docker).\n\n</p>\n</details>\n\n<details>\n<summary>Cleanup</summary>\n<p>\nDelete pycache files\n\n```bash\nmake pycache-remove\n```\n\nRemove package build\n\n```bash\nmake build-remove\n```\n\nDelete .DS_STORE files\n\n```bash\nmake dsstore-remove\n```\n\nRemove .mypycache\n\n```bash\nmake mypycache-remove\n```\n\nOr to remove all above run:\n\n```bash\nmake cleanup\n```\n\n</p>\n</details>\n\n## \ud83d\udee1 License\n\n[](https://github.com/Undertone0809/aslf/blob/main/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/Undertone0809/aslf/blob/main/LICENSE) for more details.\n\n## Credits [](https://github.com/Undertone0809/python-package-template)\n\nThis project was generated with [P3G](https://github.com/Undertone0809/P3G)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\ud83d\ude80Python client of clerk.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/Undertone0809/pyclerk",
"Repository": "https://github.com/Undertone0809/pyclerk"
},
"split_keywords": [
"pyclerk",
" clerk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3579ad63498fb9ba9fa5bdef08b43fafa8385384a533309ce80d1d3ead6a14e2",
"md5": "33a68b9de9831d7d151b06a9f9c534f0",
"sha256": "245df0e6fdbd236d11451b48f2c6c2c37bd6d2fd05d70df6f2de5eb803c226e3"
},
"downloads": -1,
"filename": "python_clerk-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33a68b9de9831d7d151b06a9f9c534f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.0",
"size": 4009,
"upload_time": "2024-07-26T18:39:07",
"upload_time_iso_8601": "2024-07-26T18:39:07.673773Z",
"url": "https://files.pythonhosted.org/packages/35/79/ad63498fb9ba9fa5bdef08b43fafa8385384a533309ce80d1d3ead6a14e2/python_clerk-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8e651dafacceaf29622f43f6b988126d6f75df51d0f77234c7ddb1bec371c598",
"md5": "aa2c66c0033aa675ebce73a06e7e8e70",
"sha256": "86057fa3cdd9f9814021eba89b8b39f8f4fdb3ce033fc54d50780f10584ab3c9"
},
"downloads": -1,
"filename": "python_clerk-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "aa2c66c0033aa675ebce73a06e7e8e70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.0",
"size": 4626,
"upload_time": "2024-07-26T18:39:09",
"upload_time_iso_8601": "2024-07-26T18:39:09.405990Z",
"url": "https://files.pythonhosted.org/packages/8e/65/1dafacceaf29622f43f6b988126d6f75df51d0f77234c7ddb1bec371c598/python_clerk-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-26 18:39:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Undertone0809",
"github_project": "pyclerk",
"github_not_found": true,
"lcname": "python-clerk"
}
JSON
