Metadata-Version: 2.1
Name: platform-users
Version: 1.0.4
Summary: This is an app for managing users in a SaaS product named Platform.
Home-page: UNKNOWN
Author: Vishwajeet Kale
Author-email: vishwajeet.kale.v2stech@gmail.com
License: MIT
Description: ```markdown
        # 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`:
        
        ```python
        INSTALLED_APPS = [
            # ...,
            'platform_users',
        ]
        ```
        
        Configure the custom user model in `settings.py`:
        
        ```python
        AUTH_USER_MODEL = 'platform_users.Users'
        ```
        
        ### Fake Migrations
        
        Run the following command to fake migrations for the `platform_users` app:
        
        ```bash
        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.
        
        ```python
        # Example:
        # parent_project_secret_key = '<some_secret_key1>'
        
        # child_project_secret_key = '<parent_project_secret_key>'
        ```
        
        ## Usage
        
        Refer to the [documentation](link_to_documentation) for detailed usage instructions.
        
        ## Documentation
        
        Visit our [official documentation](link_to_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](https://choosealicense.com/licenses/mit/).
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
