# dlrepo
[](https://builds.sr.ht/~rjarry/dlrepo)
[dlrepo][hub] is an artifact repository. It supports storing build artifacts
(binary packages, documentation, vm images, container images, etc.) in
a structured file system tree. It exposes an HTTP API to upload files, delete
them, add metadata, etc. [dlrepo][hub] does not use an external database. It
does de-duplication of artifacts by the use of file system hard links.
[hub]: https://sr.ht/~rjarry/dlrepo/
## installation
```sh
pip install dlrepo
```
Or, as `root` on Debian testing:
```sh
curl -L https://repo.diabeteman.com/static/key.asc > /etc/apt/trusted.gpg.d/repo-diabeteman-com.asc
echo "deb https://repo.diabeteman.com/products/dlrepo/all/main/0.x/deb/ /" > /etc/apt/sources.list.d/dlrepo.list
apt update
apt install dlrepo
```
## development quickstart
```sh
sudo apt install libldap2-dev libsasl2-dev python3-dev python3-pip python3-venv sassc
git clone https://git.sr.ht/~rjarry/dlrepo
cd dlrepo
make lint tests
make run
```
## documentation
* [dlrepo.7](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo.7.scdoc)
* [dlrepo-cli.1](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-cli.1.scdoc)
* [dlrepo-config.5](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-config.5.scdoc)
* [dlrepo-acls.5](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-acls.5.scdoc)
* [dlrepo-api.7](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-api.7.scdoc)
* [dlrepo-layout.7](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-layout.7.scdoc)
## contributing
Anyone can contribute to dlrepo:
* Clone the repository.
* Patch the code.
* Make some tests.
* Ensure that your code is properly formatted with black (`make format`).
* Ensure that the linters are happy (`make lint`).
* Ensure that everything works as expected.
* Ensure that you did not break anything.
* If applicable, update unit tests.
* If adding a new feature, please consider adding new tests.
* Do not forget to update the docs.
Once you are happy with your work, you can create a commit (or several
commits). Follow these general rules:
* Limit the first line (title) of the commit message to 60 characters.
* Use a short prefix for the commit title for readability with `git log --oneline`.
* Use the body of the commit message to actually explain what your patch does
and why it is useful.
* Address only one issue/topic per commit.
* If you are fixing a ticket, use appropriate
[commit trailers](https://man.sr.ht/git.sr.ht/#referencing-tickets-in-git-commit-messages).
* If you are fixing a regression introduced by another commit, add a `Fixes:`
trailer with the commit id and its title.
There is a great reference for commit messages in the
[Linux kernel documentation](https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes).
Before sending the patch, you should configure your local clone with sane
defaults:
```
git config format.subjectPrefix "PATCH dlrepo"
git config sendemail.to "~rjarry/dlrepo@lists.sr.ht"
```
And send the patch to the mailing list:
```sh
git sendemail --annotate -1
```
Wait for feedback. Address comments and amend changes to your original commit.
Then you should send a v2:
```sh
git sendemail --in-reply-to=$first_message_id --annotate -v2 -1
```
Once the maintainer is happy with your patch, they will apply it and push it.
## resources
* Browse [source code](https://git.sr.ht/~rjarry/dlrepo)
* Submit patches & questions to
[~rjarry/dlrepo@lists.sr.ht](https://lists.sr.ht/~rjarry/dlrepo)
* File or browse [tickets](https://todo.sr.ht/~rjarry/dlrepo)
Raw data
{
"_id": null,
"home_page": "https://sr.ht/~rjarry/dlrepo/",
"name": "dlrepo",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Robin Jarry",
"author_email": "robin@jarry.cc",
"download_url": "https://files.pythonhosted.org/packages/bb/d9/977d6f3448b5081239bc8f8bbcff9b192180bf299cdb29a4e03fda65cc74/dlrepo-0.40.tar.gz",
"platform": null,
"description": "# dlrepo\n\n[](https://builds.sr.ht/~rjarry/dlrepo)\n\n[dlrepo][hub] is an artifact repository. It supports storing build artifacts\n(binary packages, documentation, vm images, container images, etc.) in\na structured file system tree. It exposes an HTTP API to upload files, delete\nthem, add metadata, etc. [dlrepo][hub] does not use an external database. It\ndoes de-duplication of artifacts by the use of file system hard links.\n\n[hub]: https://sr.ht/~rjarry/dlrepo/\n\n## installation\n\n```sh\npip install dlrepo\n```\n\nOr, as `root` on Debian testing:\n\n```sh\ncurl -L https://repo.diabeteman.com/static/key.asc > /etc/apt/trusted.gpg.d/repo-diabeteman-com.asc\necho \"deb https://repo.diabeteman.com/products/dlrepo/all/main/0.x/deb/ /\" > /etc/apt/sources.list.d/dlrepo.list\napt update\napt install dlrepo\n```\n\n## development quickstart\n\n```sh\nsudo apt install libldap2-dev libsasl2-dev python3-dev python3-pip python3-venv sassc\ngit clone https://git.sr.ht/~rjarry/dlrepo\ncd dlrepo\nmake lint tests\nmake run\n```\n\n## documentation\n\n* [dlrepo.7](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo.7.scdoc)\n* [dlrepo-cli.1](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-cli.1.scdoc)\n* [dlrepo-config.5](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-config.5.scdoc)\n* [dlrepo-acls.5](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-acls.5.scdoc)\n* [dlrepo-api.7](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-api.7.scdoc)\n* [dlrepo-layout.7](https://git.sr.ht/~rjarry/dlrepo/tree/main/item/docs/dlrepo-layout.7.scdoc)\n\n## contributing\n\nAnyone can contribute to dlrepo:\n\n* Clone the repository.\n* Patch the code.\n* Make some tests.\n* Ensure that your code is properly formatted with black (`make format`).\n* Ensure that the linters are happy (`make lint`).\n* Ensure that everything works as expected.\n* Ensure that you did not break anything.\n* If applicable, update unit tests.\n* If adding a new feature, please consider adding new tests.\n* Do not forget to update the docs.\n\nOnce you are happy with your work, you can create a commit (or several\ncommits). Follow these general rules:\n\n* Limit the first line (title) of the commit message to 60 characters.\n* Use a short prefix for the commit title for readability with `git log --oneline`.\n* Use the body of the commit message to actually explain what your patch does\n and why it is useful.\n* Address only one issue/topic per commit.\n* If you are fixing a ticket, use appropriate\n [commit trailers](https://man.sr.ht/git.sr.ht/#referencing-tickets-in-git-commit-messages).\n* If you are fixing a regression introduced by another commit, add a `Fixes:`\n trailer with the commit id and its title.\n\nThere is a great reference for commit messages in the\n[Linux kernel documentation](https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes).\n\nBefore sending the patch, you should configure your local clone with sane\ndefaults:\n\n```\ngit config format.subjectPrefix \"PATCH dlrepo\"\ngit config sendemail.to \"~rjarry/dlrepo@lists.sr.ht\"\n```\n\nAnd send the patch to the mailing list:\n\n```sh\ngit sendemail --annotate -1\n```\n\nWait for feedback. Address comments and amend changes to your original commit.\nThen you should send a v2:\n\n```sh\ngit sendemail --in-reply-to=$first_message_id --annotate -v2 -1\n```\n\nOnce the maintainer is happy with your patch, they will apply it and push it.\n\n## resources\n\n* Browse [source code](https://git.sr.ht/~rjarry/dlrepo)\n* Submit patches & questions to\n [~rjarry/dlrepo@lists.sr.ht](https://lists.sr.ht/~rjarry/dlrepo)\n* File or browse [tickets](https://todo.sr.ht/~rjarry/dlrepo)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Artifact repository",
"version": "0.40",
"project_urls": {
"Homepage": "https://sr.ht/~rjarry/dlrepo/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbd9977d6f3448b5081239bc8f8bbcff9b192180bf299cdb29a4e03fda65cc74",
"md5": "35d50659fbc881a5268c254b7a02be89",
"sha256": "5bf6140e1cc3585e9d73f89f3e811cc8b7d16fb7549a8682e438fbbaa692c4e5"
},
"downloads": -1,
"filename": "dlrepo-0.40.tar.gz",
"has_sig": false,
"md5_digest": "35d50659fbc881a5268c254b7a02be89",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 157857,
"upload_time": "2024-11-20T15:37:31",
"upload_time_iso_8601": "2024-11-20T15:37:31.481257Z",
"url": "https://files.pythonhosted.org/packages/bb/d9/977d6f3448b5081239bc8f8bbcff9b192180bf299cdb29a4e03fda65cc74/dlrepo-0.40.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 15:37:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dlrepo"
}
JSON