huscy.project_documents
======
Requirements
------
- Python 3.8+
- A supported version of Django
Tox tests on Django versions 4.2 and 5.0.
Installation
------
To install `husy.project_documents` simply run:
```
pip install huscy.project_documents
```
Configuration
------
We need to hook `huscy.project_documents` into our project.
This package depends on `huscy.projects` so we have to add this as well.
We also have to add further requirements for django_guardian, django_restframework and drf_nested_routers.
1. Add packages into your `INSTALLED_APPS` at settings module:
```python
INSTALLED_APPS = (
...
'guardian',
'rest_framework',
'rest_framework_nested',
'huscy.project_documents',
'huscy.projects',
)
```
2. Create `huscy.project_documents` database tables by running:
```
python manage.py migrate
```
Development
------
After checking out the repository you should run
```
make install
```
to install all development and test requirements and
```
make migrate
```
to create the database tables.
We assume you have a running postgres database with a user `huscy` and a database also called `huscy`.
You can easily create them by running
```
sudo -u postgres createdb huscy
sudo -u postgres createuser -d huscy
sudo -u postgres psql -c "ALTER USER huscy WITH PASSWORD '123'"
sudo -u postgres psql -c "ALTER DATABASE huscy OWNER TO huscy;"
```
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/huscy/project_documents",
"name": "huscy.project-documents",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Alexander Tyapkov, Mathias Goldau, Stefan Bunde",
"author_email": "tyapkov@gmail.com, goldau@cbs.mpg.de, stefanbunde+git@posteo.de",
"download_url": "https://files.pythonhosted.org/packages/fe/cb/e7f78740a5328c9a9eef41ebee284a071a8577ea0437192e3e02993f72e8/huscy.project_documents-1.4.1.tar.gz",
"platform": null,
"description": "huscy.project_documents\n======\n\n\n\n\n\n\n\n\n\n\nRequirements\n------\n\n- Python 3.8+\n- A supported version of Django\n\nTox tests on Django versions 4.2 and 5.0.\n\n\n\nInstallation\n------\n\nTo install `husy.project_documents` simply run:\n```\npip install huscy.project_documents\n```\n\n\n\nConfiguration\n------\n\nWe need to hook `huscy.project_documents` into our project.\nThis package depends on `huscy.projects` so we have to add this as well.\nWe also have to add further requirements for django_guardian, django_restframework and drf_nested_routers.\n\n1. Add packages into your `INSTALLED_APPS` at settings module:\n\n```python\nINSTALLED_APPS = (\n ...\n 'guardian',\n 'rest_framework',\n 'rest_framework_nested',\n\n 'huscy.project_documents',\n 'huscy.projects',\n)\n```\n\n2. Create `huscy.project_documents` database tables by running:\n\n```\npython manage.py migrate\n```\n\n\nDevelopment\n------\n\nAfter checking out the repository you should run\n\n```\nmake install\n```\n\nto install all development and test requirements and\n\n```\nmake migrate\n```\n\nto create the database tables.\nWe assume you have a running postgres database with a user `huscy` and a database also called `huscy`.\nYou can easily create them by running\n\n```\nsudo -u postgres createdb huscy\nsudo -u postgres createuser -d huscy\nsudo -u postgres psql -c \"ALTER USER huscy WITH PASSWORD '123'\"\nsudo -u postgres psql -c \"ALTER DATABASE huscy OWNER TO huscy;\"\n```\n\n\n",
"bugtrack_url": null,
"license": "AGPLv3+",
"summary": "Managing document files for projects.",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://bitbucket.org/huscy/project_documents"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eac4e35735a8bd2d3e4daff793d6ef06fd3c0e3eb28812594dd501ff07985435",
"md5": "acc158ef70f0f6e342c4346b89da854e",
"sha256": "c0dde78506a3f188f7611945f6d0c5b8bd69fa2f6f6451cd5cc15691e386f7a2"
},
"downloads": -1,
"filename": "huscy.project_documents-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acc158ef70f0f6e342c4346b89da854e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20250,
"upload_time": "2024-03-26T13:26:53",
"upload_time_iso_8601": "2024-03-26T13:26:53.265336Z",
"url": "https://files.pythonhosted.org/packages/ea/c4/e35735a8bd2d3e4daff793d6ef06fd3c0e3eb28812594dd501ff07985435/huscy.project_documents-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fecbe7f78740a5328c9a9eef41ebee284a071a8577ea0437192e3e02993f72e8",
"md5": "d40b22e2e2cac3d63c2b6ca32ee05eb5",
"sha256": "e1752a3ae2ec5558f5c244408eb5739bee487984e44d2994ad7c11ad977c6e4b"
},
"downloads": -1,
"filename": "huscy.project_documents-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "d40b22e2e2cac3d63c2b6ca32ee05eb5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6752,
"upload_time": "2024-03-26T13:26:55",
"upload_time_iso_8601": "2024-03-26T13:26:55.130856Z",
"url": "https://files.pythonhosted.org/packages/fe/cb/e7f78740a5328c9a9eef41ebee284a071a8577ea0437192e3e02993f72e8/huscy.project_documents-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 13:26:55",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "huscy",
"bitbucket_project": "project_documents",
"lcname": "huscy.project-documents"
}
JSON