<h1 align="center">
<a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
<br>
Argilla-Server
<br>
</h1>
<h3 align="center">The repository for the Python native FastAPI server for Argilla backend.</h2>
<p align="center">
<a href="https://pypi.org/project/argilla-server/">
<img alt="CI" src="https://img.shields.io/pypi/v/argilla.svg?style=flat-round&logo=pypi&logoColor=white">
</a>
<img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla-server/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
<a href="https://pepy.tech/project/argilla-server">
<img alt="CI" src="https://static.pepy.tech/personalized-badge/argilla-server?period=month&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads/month">
</a>
<a href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
<img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg"/>
</a>
</p>
<p align="center">
<a href="https://twitter.com/argilla_io">
<img src="https://img.shields.io/badge/twitter-black?logo=x"/>
</a>
<a href="https://www.linkedin.com/company/argilla-io">
<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
</a>
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
</a>
</p>
Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
This repository only contains developer info about the backend server. If you want to get started, we recommend taking a look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/).
Are you a contributor or do you want to understand what is going on under the hood, please keep reading the documentation below.
## Clone repository
`argilla-server` is using `argilla` repository as submodule to build frontend statics so when cloning use the following command:
```sh
git clone --recurse-submodules git@github.com:argilla-io/argilla-server.git
```
If you already cloned the repository without using `--recurse-submodules` you can init and update the submodules with:
```sh
git submodule update --remote --recursive --init
```
> [!IMPORTANT]
> By default `argilla` submodule is using `develop` branch so the previous command will get the latest commit from that branch.
### Specify a tag for argilla submodule
When doing a release we should change `argilla` submodule to use an specific tag. In the following example we are setting tag `v1.22.0`:
```sh
cd argilla
git fetch --tags
git checkout v1.22.0
```
> [!NOTE]
> You should see some changes on the `argilla-server` root folder where the subproject commit is now changed to the one from the tag version. Feel free to commit these changes.
## Development environment
By default all commands executed with `pdm run` will get environment variables from `.env.dev` except command `pdm test` that will overwrite some of them using values coming from `.env.test` file.
These environment variables can be overrided if necessary so feel free to defined your own ones locally.
### Run cli
```sh
pdm cli
```
### Run database migrations
By default a SQLite located at `~/.argilla/argilla.db` will be used. You can create the database and run migrations with the following custom PDM command:
```sh
pdm migrate
```
### Run tests
A SQLite database located at `~/.argilla/argilla-test.db` will be automatically created to run tests. You can run the entire test suite using the following custom PDM command:
```sh
pdm test
```
## Run development server
### Build frontend static files
Before running Argilla development server we need to build the frontend static files. Node version 18 is required for this action:
```sh
brew install node@18
```
After that you can build the frontend static files:
```sh
./scripts/build_frontend.sh
```
After running the previous script you should have a folder at `src/argilla_server/static` with all the frontend static files successfully generated.
### Run uvicorn development server
```sh
pdm server
```
Raw data
{
"_id": null,
"home_page": "https://www.argilla.io",
"name": "argilla-server",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.11,>=3.8",
"maintainer_email": "argilla <contact@argilla.io>",
"keywords": "data-science natural-language-processing text-labeling data-annotation artificial-intelligence knowledged-graph developers-tools human-in-the-loop mlops",
"author": null,
"author_email": "argilla <contact@argilla.io>",
"download_url": "https://files.pythonhosted.org/packages/09/84/175c972e96746f282fec81ee41f997f32d7514d258eec2ed6ba19eaed829/argilla_server-1.26.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <a href=\"\"><img src=\"https://github.com/dvsrepo/imgs/raw/main/rg.svg\" alt=\"Argilla\" width=\"150\"></a>\n <br>\n Argilla-Server\n <br>\n</h1>\n<h3 align=\"center\">The repository for the Python native FastAPI server for Argilla backend.</h2>\n\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/argilla-server/\">\n<img alt=\"CI\" src=\"https://img.shields.io/pypi/v/argilla.svg?style=flat-round&logo=pypi&logoColor=white\">\n</a>\n<img alt=\"Codecov\" src=\"https://codecov.io/gh/argilla-io/argilla-server/branch/main/graph/badge.svg?token=VDVR29VOMG\"/>\n<a href=\"https://pepy.tech/project/argilla-server\">\n<img alt=\"CI\" src=\"https://static.pepy.tech/personalized-badge/argilla-server?period=month&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads/month\">\n</a>\n<a href=\"https://huggingface.co/new-space?template=argilla/argilla-template-space\">\n<img src=\"https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg\"/>\n</a>\n</p>\n\n<p align=\"center\">\n<a href=\"https://twitter.com/argilla_io\">\n<img src=\"https://img.shields.io/badge/twitter-black?logo=x\"/>\n</a>\n<a href=\"https://www.linkedin.com/company/argilla-io\">\n<img src=\"https://img.shields.io/badge/linkedin-blue?logo=linkedin\"/>\n</a>\n<a href=\"https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g\">\n<img src=\"https://img.shields.io/badge/slack-purple?logo=slack\"/>\n</a>\n</p>\n\nArgilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.\n\nThis repository only contains developer info about the backend server. If you want to get started, we recommend taking a look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/).\n\nAre you a contributor or do you want to understand what is going on under the hood, please keep reading the documentation below.\n\n## Clone repository\n\n`argilla-server` is using `argilla` repository as submodule to build frontend statics so when cloning use the following command:\n\n```sh\ngit clone --recurse-submodules git@github.com:argilla-io/argilla-server.git\n```\n\nIf you already cloned the repository without using `--recurse-submodules` you can init and update the submodules with:\n\n```sh\ngit submodule update --remote --recursive --init\n```\n\n> [!IMPORTANT]\n> By default `argilla` submodule is using `develop` branch so the previous command will get the latest commit from that branch.\n\n### Specify a tag for argilla submodule\n\nWhen doing a release we should change `argilla` submodule to use an specific tag. In the following example we are setting tag `v1.22.0`:\n\n```sh\ncd argilla\ngit fetch --tags\ngit checkout v1.22.0\n```\n\n> [!NOTE]\n> You should see some changes on the `argilla-server` root folder where the subproject commit is now changed to the one from the tag version. Feel free to commit these changes.\n\n## Development environment\n\nBy default all commands executed with `pdm run` will get environment variables from `.env.dev` except command `pdm test` that will overwrite some of them using values coming from `.env.test` file.\n\nThese environment variables can be overrided if necessary so feel free to defined your own ones locally.\n\n### Run cli\n\n```sh\npdm cli\n```\n\n### Run database migrations\n\nBy default a SQLite located at `~/.argilla/argilla.db` will be used. You can create the database and run migrations with the following custom PDM command:\n\n```sh\npdm migrate\n```\n\n### Run tests\n\nA SQLite database located at `~/.argilla/argilla-test.db` will be automatically created to run tests. You can run the entire test suite using the following custom PDM command:\n\n```sh\npdm test\n```\n\n## Run development server\n\n### Build frontend static files\n\nBefore running Argilla development server we need to build the frontend static files. Node version 18 is required for this action:\n\n```sh\nbrew install node@18\n```\n\nAfter that you can build the frontend static files:\n\n```sh\n./scripts/build_frontend.sh\n```\n\nAfter running the previous script you should have a folder at `src/argilla_server/static` with all the frontend static files successfully generated.\n\n### Run uvicorn development server\n\n```sh\npdm server\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Open-source tool for exploring, labeling, and monitoring data for NLP projects.",
"version": "1.26.1",
"project_urls": {
"Documentation": "https://docs.argilla.io",
"Homepage": "https://www.argilla.io",
"Repository": "https://github.com/argilla-io/argilla"
},
"split_keywords": [
"data-science",
"natural-language-processing",
"text-labeling",
"data-annotation",
"artificial-intelligence",
"knowledged-graph",
"developers-tools",
"human-in-the-loop",
"mlops"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc7e5376ac44743be2ed4736a7f8887df7a87745aa2b52d5c4cbe26d00933609",
"md5": "e1d64dd6101ec1b4a946229aa5d988c8",
"sha256": "c4fed7d26ce8a1854b227cea3ffc1419f3f0ae4d60f717d4b42a74f64bcde55f"
},
"downloads": -1,
"filename": "argilla_server-1.26.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1d64dd6101ec1b4a946229aa5d988c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.8",
"size": 3257908,
"upload_time": "2024-03-27T13:02:07",
"upload_time_iso_8601": "2024-03-27T13:02:07.156097Z",
"url": "https://files.pythonhosted.org/packages/bc/7e/5376ac44743be2ed4736a7f8887df7a87745aa2b52d5c4cbe26d00933609/argilla_server-1.26.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0984175c972e96746f282fec81ee41f997f32d7514d258eec2ed6ba19eaed829",
"md5": "7cf7afd34facccab53f27a10fc39bf96",
"sha256": "6bf8eb092b6df1efe7fcff2f73a740ca01967a2275eb6f1a14ea89d3efa32375"
},
"downloads": -1,
"filename": "argilla_server-1.26.1.tar.gz",
"has_sig": false,
"md5_digest": "7cf7afd34facccab53f27a10fc39bf96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.8",
"size": 2880310,
"upload_time": "2024-03-27T13:02:09",
"upload_time_iso_8601": "2024-03-27T13:02:09.179028Z",
"url": "https://files.pythonhosted.org/packages/09/84/175c972e96746f282fec81ee41f997f32d7514d258eec2ed6ba19eaed829/argilla_server-1.26.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 13:02:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "argilla-io",
"github_project": "argilla",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "argilla-server"
}
JSON
