# minchoc
[](https://github.com/Tatsh/minchoc/actions/workflows/qa.yml)
[](https://github.com/Tatsh/minchoc/actions/workflows/tests.yml)
[](https://coveralls.io/github/Tatsh/minchoc?branch=master)
[](https://minchoc.readthedocs.io/en/latest/?badge=latest)
**Min**imal **Choc**olatey-compatible NuGet server in a Django app.
## Installation
```shell
pip install minchoc
```
In `settings.py`, add `'minchoc'` to `INSTALLED_APPS`. Set `ALLOW_PACKAGE_DELETION` to `True` if you
want to enable this API.
```python
INSTALLED_APPS = ['minchoc']
ALLOW_PACKAGE_DELETION = True
```
A `DELETE` call to `/api/v2/package/<id>/<version>` will be denied even with authentication unless
`ALLOW_PACKAGE_DELETION` is set to `True`.
Add `path('', include('minchoc.urls'))` to your root `urls.py`. Example:
```python
from django.urls import include, path
urlpatterns = [
path('admin/', admin.site.urls),
path('', include('minchoc.urls')),
]
```
Run `./manage.py migrate` or similar to install the database schema.
## Notes
When a user is created, a `NugetUser` is also made. This will contain the API key for pushing.
It can be viewed in admin.
### Add your source to Chocolatey
As administrator:
```shell
choco source add -s 'https://your-host/url-prefix'
choco apikey add -s 'https://your-host/url-prefix' -k 'your-key'
```
On non-Windows platforms, you can use my [pychoco](https://github.com/Tatsh/pychoco) package, which
also supports the above commands.
### Supported commands
- `choco install`
- `choco push`
- `choco search`
Raw data
{
"_id": null,
"home_page": "https://github.com/Tatsh/minchoc",
"name": "minchoc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4",
"maintainer_email": "",
"keywords": "chocolatey,django,windows",
"author": "Andrew Udvare",
"author_email": "audvare@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/29/59/8636aa69d0074fa18e5a4d15ea99674a65311e160085fd31ab23f1f9fd9f/minchoc-0.0.11.tar.gz",
"platform": null,
"description": "# minchoc\n\n[](https://github.com/Tatsh/minchoc/actions/workflows/qa.yml)\n[](https://github.com/Tatsh/minchoc/actions/workflows/tests.yml)\n[](https://coveralls.io/github/Tatsh/minchoc?branch=master)\n[](https://minchoc.readthedocs.io/en/latest/?badge=latest)\n\n\n\n\n\n**Min**imal **Choc**olatey-compatible NuGet server in a Django app.\n\n## Installation\n\n```shell\npip install minchoc\n```\n\nIn `settings.py`, add `'minchoc'` to `INSTALLED_APPS`. Set `ALLOW_PACKAGE_DELETION` to `True` if you\nwant to enable this API.\n\n```python\nINSTALLED_APPS = ['minchoc']\nALLOW_PACKAGE_DELETION = True\n```\n\nA `DELETE` call to `/api/v2/package/<id>/<version>` will be denied even with authentication unless\n`ALLOW_PACKAGE_DELETION` is set to `True`.\n\nAdd `path('', include('minchoc.urls'))` to your root `urls.py`. Example:\n\n```python\nfrom django.urls import include, path\nurlpatterns = [\n path('admin/', admin.site.urls),\n path('', include('minchoc.urls')),\n]\n```\n\nRun `./manage.py migrate` or similar to install the database schema.\n\n## Notes\n\nWhen a user is created, a `NugetUser` is also made. This will contain the API key for pushing.\nIt can be viewed in admin.\n\n### Add your source to Chocolatey\n\nAs administrator:\n\n```shell\nchoco source add -s 'https://your-host/url-prefix'\nchoco apikey add -s 'https://your-host/url-prefix' -k 'your-key'\n```\n\nOn non-Windows platforms, you can use my [pychoco](https://github.com/Tatsh/pychoco) package, which\nalso supports the above commands.\n\n### Supported commands\n\n- `choco install`\n- `choco push`\n- `choco search`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Minimal Chocolatey-compatible NuGet server in a Django app.",
"version": "0.0.11",
"project_urls": {
"Documentation": "https://minchoc.readthedocs.io/",
"Homepage": "https://github.com/Tatsh/minchoc",
"Repository": "https://github.com/Tatsh/minchoc"
},
"split_keywords": [
"chocolatey",
"django",
"windows"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e178f741cad0ad61527074cd7bb163316479d38b95b4e4e6ee756c0a0268dfa3",
"md5": "35b99373c57b00bd77336891f199937c",
"sha256": "da45d1d8a85741be967581043bae37dded91ca166bcfa85a31487c73659ce32b"
},
"downloads": -1,
"filename": "minchoc-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "35b99373c57b00bd77336891f199937c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4",
"size": 17127,
"upload_time": "2023-12-11T02:05:21",
"upload_time_iso_8601": "2023-12-11T02:05:21.245570Z",
"url": "https://files.pythonhosted.org/packages/e1/78/f741cad0ad61527074cd7bb163316479d38b95b4e4e6ee756c0a0268dfa3/minchoc-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29598636aa69d0074fa18e5a4d15ea99674a65311e160085fd31ab23f1f9fd9f",
"md5": "46ae580ee2b77b7b9f9345af9425223d",
"sha256": "7dbcbb220b6069972ca5805553753425fd91e8f4f8acf6ef11ac0674b33a0364"
},
"downloads": -1,
"filename": "minchoc-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "46ae580ee2b77b7b9f9345af9425223d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4",
"size": 15947,
"upload_time": "2023-12-11T02:05:22",
"upload_time_iso_8601": "2023-12-11T02:05:22.971957Z",
"url": "https://files.pythonhosted.org/packages/29/59/8636aa69d0074fa18e5a4d15ea99674a65311e160085fd31ab23f1f9fd9f/minchoc-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-11 02:05:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Tatsh",
"github_project": "minchoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "minchoc"
}
JSON
