This is an app for managing users in a SaaS product named Platform.
Project description
# platform-users: Django Authentication Module
`platform-users` is a comprehensive Django authentication module designed to streamline user authentication in your projects. It offers a range of features, including a customizable user model, JWT-based authentication, and easy integration.
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Custom User Model](#custom-user-model)
- [Middleware](#middleware)
- [Fake Migrations](#fake-migrations)
- [Secret Key Replacement](#secret-key-replacement)
- [Usage](#usage)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `platform-users`.
```bash
pip install platform-users
Configuration
Custom User Model
Update your project's INSTALLED_APPS
setting in settings.py
:
INSTALLED_APPS = [
# ...,
'platform_users',
]
Configure the custom user model in settings.py
:
AUTH_USER_MODEL = 'platform_users.Users'
Middleware
Add the JWTMiddleware
to your project's middleware in settings.py
:
MIDDLEWARE = [
# ...,
'platform_users.middleware.JWTMiddleware',
# ...,
]
Fake Migrations
Run the following command to fake migrations for the platform_users
app:
python manage.py migrate platform_users --fake
Secret Key Replacement
Replace the secret key in your child project with the secret key from platform-users
. Keep the secret key secure.
# Example:
# parent_project_secret_key = '<some_secret_key1>'
# child_project_secret_key = '<parent_project_secret_key>'
Usage
Refer to the documentation for detailed usage instructions.
Documentation
Visit our official documentation for comprehensive information, API references, and usage examples.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for platform_users-0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c09955f55fa2c67fabd897692b667df2098bcda9230f16ba1f34a1a2486d281 |
|
MD5 | a4b03c0ab908527a1e2aa089cae85ed6 |
|
BLAKE2b-256 | eeb4567e1e5bf71b6d978497de41f515b46a10f85e565e3a886013b89a4d9c5a |