# huscy.projects
[](https://coveralls.io/bitbucket/huscy/projects?branch=master)
## Requirements
- Python 3.8+
- A supported version of Django
Tox tests on Django versions 4.2, 5.0 and 5.1.
## Installation
To install `husy.projects` simply run:
pip install huscy.projects
Add `huscy.projects` and further required apps to `INSTALLED_APPS` in your settings module:
```python
INSTALLED_APPS = (
...
'guardian',
'rest_framework',
'huscy.projects',
)
```
Add Django Guardian ObjectPermissionBackend to AUTHENTICATION_BACKENDS
```python
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'guardian.backends.ObjectPermissionBackend',
)
```
Hook the urls from `huscy.projects` into your urls.py:
```python
urlpatterns = [
...
path('/api/', include('huscy.projects.urls')),
]
```
Create `huscy.projects` database tables by running:
python manage.py migrate
## Development
Install PostgreSQL and create a database user called `huscy` and a database called `huscy`.
sudo -u postgres createdb huscy
sudo -u postgres createuser -d huscy
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE huscy TO huscy;"
sudo -u postgres psql -c "ALTER USER huscy WITH PASSWORD '123';"
Checking out the repository start your virtual environment (if necessary).
Install all development and test dependencies:
make install
Create Database tables:
make migrate
Run tests to see if everything works fine:
make test
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/huscy/projects/",
"name": "huscy.projects",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Mathias Goldau, Stefan Bunde",
"author_email": "goldau@cbs.mpg.de, stefanbunde+git@posteo.de",
"download_url": "https://files.pythonhosted.org/packages/8d/ab/247574c86fc99d8caa4a5bf468f66e54c5cf7ab22c11441a6f2cc6392835/huscy_projects-1.7.2.tar.gz",
"platform": null,
"description": "# huscy.projects\n\n\n\n\n\n\n\n[](https://coveralls.io/bitbucket/huscy/projects?branch=master)\n\n\n\n## Requirements\n\n- Python 3.8+\n- A supported version of Django\n\nTox tests on Django versions 4.2, 5.0 and 5.1.\n\n\n\n## Installation\n\nTo install `husy.projects` simply run:\n\n\tpip install huscy.projects\n\n\nAdd `huscy.projects` and further required apps to `INSTALLED_APPS` in your settings module:\n\n```python\nINSTALLED_APPS = (\n\t...\n\t'guardian',\n\t'rest_framework',\n\n\t'huscy.projects',\n)\n```\n\nAdd Django Guardian ObjectPermissionBackend to AUTHENTICATION_BACKENDS\n\n```python\nAUTHENTICATION_BACKENDS = (\n 'django.contrib.auth.backends.ModelBackend',\n 'guardian.backends.ObjectPermissionBackend',\n)\n```\n\nHook the urls from `huscy.projects` into your urls.py:\n\n```python\nurlpatterns = [\n ...\n\tpath('/api/', include('huscy.projects.urls')),\n]\n```\n\nCreate `huscy.projects` database tables by running:\n\n\tpython manage.py migrate\n\n\n\n## Development\n\nInstall PostgreSQL and create a database user called `huscy` and a database called `huscy`.\n\n\tsudo -u postgres createdb huscy\n\tsudo -u postgres createuser -d huscy\n\tsudo -u postgres psql -c \"GRANT ALL PRIVILEGES ON DATABASE huscy TO huscy;\"\n\tsudo -u postgres psql -c \"ALTER USER huscy WITH PASSWORD '123';\"\n\nChecking out the repository start your virtual environment (if necessary).\n\nInstall all development and test dependencies:\n\n\tmake install\n\nCreate Database tables:\n\n\tmake migrate\n\nRun tests to see if everything works fine:\n\n\tmake test\n",
"bugtrack_url": null,
"license": "AGPLv3+",
"summary": "Managing projects in a research context.",
"version": "1.7.2",
"project_urls": {
"Homepage": "https://bitbucket.org/huscy/projects/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f1a7260efd6b00c7b6895c4812a3d088f1382de78cf230ac33fd85f94443177c",
"md5": "ee1eab77e80cba98744d0fd0361e5472",
"sha256": "064e287b61ed2f263b1b6d19a7961a290655e01b880eff479d6a2e8eafcb52af"
},
"downloads": -1,
"filename": "huscy.projects-1.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee1eab77e80cba98744d0fd0361e5472",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23862,
"upload_time": "2025-01-31T15:21:58",
"upload_time_iso_8601": "2025-01-31T15:21:58.937478Z",
"url": "https://files.pythonhosted.org/packages/f1/a7/260efd6b00c7b6895c4812a3d088f1382de78cf230ac33fd85f94443177c/huscy.projects-1.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8dab247574c86fc99d8caa4a5bf468f66e54c5cf7ab22c11441a6f2cc6392835",
"md5": "0c3a704c55e9c29f450ce6768ec961f3",
"sha256": "fa07142218291b85200f45eee57ef994cea64f24a8f4d4159d2290c453960cd6"
},
"downloads": -1,
"filename": "huscy_projects-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "0c3a704c55e9c29f450ce6768ec961f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24596,
"upload_time": "2025-01-31T15:22:00",
"upload_time_iso_8601": "2025-01-31T15:22:00.803489Z",
"url": "https://files.pythonhosted.org/packages/8d/ab/247574c86fc99d8caa4a5bf468f66e54c5cf7ab22c11441a6f2cc6392835/huscy_projects-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-31 15:22:00",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "huscy",
"bitbucket_project": "projects",
"lcname": "huscy.projects"
}
JSON