Metadata-Version: 1.2
Name: django-bcmr
Version: 0.0.14
Summary: A Django app for storing, accessing and managing CashToken Bitcoin Cash Metadata Registries
Home-page: https://github.com/paytaca/django-bcmr
Author: Paytaca
Author-email: info@paytaca.com
License: BSD-3-Clause
Description: =====
        BCMR
        =====
        
        BCMR or Bitcoin Cash Metadata Registry is a Django app for storing, accessing and managing CashToken BCMRs.
        
        Quick start
        -----------
        
        1. Add the following to your requirements.txt::
            
            Pillow==9.4.0
            django-bcmr==x.x.x
        
        2. Add "bcmr" to your INSTALLED_APPS setting like this::
        
            INSTALLED_APPS = [
                ...
                'bcmr',
            ]
        
        3. Include the bcmr URLconf in your project urls.py like this::
        
            path('bcmr/', include('bcmr.urls')),
        
        4. Add media config on settings.py::
        
            MEDIA_URL = '/media/'
            MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
        
        5. (upon deployment) Add media location path on nginx configuration file::
        
            location /media {
                proxy_pass http://127.0.0.1:8000;
                root /root/<project_name>;
            }
        
            location /bcmr {
                proxy_pass http://127.0.0.1:8000;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                proxy_set_header Host $host;
                proxy_redirect off;
            }
        
        4. Start the development server and visit http://localhost:8000/admin/
           to access the DB (you'll need the Admin app enabled).
        
        5. Visit http://localhost:8000/bcmr/ to check API endpoints for BCMRs and tokens.
        
        
        REST API
        -----------
        
        API Docs = http://localhost:8000/api/docs/
        
        Registries and tokens created by a user can only be modified or deleted by that user.
        
        All endpoints are restricted on its usage for prevention of users tampering other user's registries and tokens.
        An auth token generated upon creation of either a registry or token helps impose this restriction -- ``owner key``.
        This token is used as a header for identification if the user modifying BCMR data is the owner.
        Header name is ``Bcmr-Auth``.
        
        The endpoints are restricted as follows::
        
            GET = no header required
            POST = if header is supplied, created token/registry will belong to that auth token owner
                 = if header is not supplied, a new auth token will be generated
            PUT/PATCH = header required
            DELETE = header required
        
        
        Create Fungible Token Form
        ----------------------------
        
        Creating a token from the REST API can be a hassle as one needs to process the image before passing it
        as payload. This special route helps ease that burden by simply providing users to create a token and
        upload an image without having to login to the admin: ``create_token/fungible/``
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Database :: Database Engines/Servers
Requires-Python: >=3.6
