Metadata-Version: 2.1
Name: huscy.users
Version: 1.2.0
Summary: Listing and creating users via REST API
Home-page: https://bitbucket.org/huscy/users
Author: Stefan Bunde
Author-email: stefanbunde+git@posteo.de
License: AGPLv3+
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Description-Content-Type: text/markdown
Requires-Dist: Django (>=3.2)
Requires-Dist: djangorestframework (>=3.11)
Provides-Extra: development
Requires-Dist: psycopg2-binary ; extra == 'development'
Provides-Extra: testing
Requires-Dist: tox ; extra == 'testing'
Requires-Dist: watchdog ; extra == 'testing'

# huscy.users

![PyPi Version](https://img.shields.io/pypi/v/huscy-users.svg)
![PyPi Status](https://img.shields.io/pypi/status/huscy-users)
![PyPI Downloads](https://img.shields.io/pypi/dm/huscy-users)
![PyPI License](https://img.shields.io/pypi/l/huscy-users?color=yellow)
![Python Versions](https://img.shields.io/pypi/pyversions/huscy-users.svg)
![Django Versions](https://img.shields.io/pypi/djversions/huscy-users)



## Requirements

- Python 3.7+
- A supported version of Django

Tox tests on Django versions 3.2, 4.0 and 4.1.



## Installation

To install `husy.users` simply run:

	pip install huscy.users



## Configuration

The `huscy.users` application has to be hooked into the project.

Add `huscy.users` to `INSTALLED_APPS` in settings module:

```python
INSTALLED_APPS = (
	...

	'huscy.users',
)
```



## Development

After checking out the repository you should activate any virtual environment.
Install all development and test dependencies:

	make install

Create database tables:

	python manage.py migrate

We assume you're having 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;"


