chuchuro-profilelib 0.1.95
Chuchuro Auth, user and profile package manager
Requires Python: >=3.6

## Profile package manager
<b>
Chuchuro profile package is a complete package with 
Email Registration Verification,User Authentication,User Authorization, Forget Password, 
User Roles and Permissions, User Profiles.
</b>

<h4>Table of contents</h4>
<hr>
<ul>
    <li><a href="#about">About</a></li>
    <li><a href="#installation-instruction">Installation Instructions</a></li>
    <li><a href="#features">Features</a></li>
    <li><a href="#compatiable">Compatibility</a></li>
    <li><a href="#requirements">Requirements</a></li>
    <li><a href="#route-list">Route List</a></li>
    <li><a href="#simple-example">Sample Example</a></li>
    <li><a href="#package-license">Profile package manager License</a></li>
    <li><a href="#links">Links</a></li>
</ul>
<h3><a id="user-content-about" class="anchor" aria-hidden="true" href="#about"></a>About</h3>   
Profile package manager is used for Email Registration Verification,User Authentication,User Authorization, Forget Password, 
User Roles and Permissions and User Profiles.

<h4><a href="#installation-instruction"></a>Installation Instructions</h4>
 1. In the terminal, run command from below to install package.
    <pre>pip3 install chuchuro-profilelib</pre>
 2. Run compilation script. (<pre>profilelib-compile</pre>)<br>
 3. In the terminal, run command from below to migrate files from package. <br>
    <pre>profilelib-run-migration --env=dev_(developer_name)</pre>
 4. Copy key and token generated by package from command prompt/terminal
    <pre>
    e.g
     <span class="pl-e">api_key : 02b09ba10c1bd8a3dfb2
     api_token: 5bfe4f9c7c5ce64e372928d029ee4b7ff065</span>
    </pre>   
    <h4>To upgrade package</h4>
    <pre>pip3 install chuchuro-profilelib --upgrade</pre></pre>    
<h4><a href="#features"></a>Features</h4>
<table>
<tr><td>Features</td></tr>
<tr><td>Built on Python 3.6</td></tr>
<tr><td>Uses Postgres (can be changed)</td></tr>
<tr><td>CRUD (Create, Read, Update, Delete) User</td></tr>
<tr><td>Creates api token and key</td></tr>
<tr><td>CRUD (Create, Read, Update, Delete) User Profile</td></tr>
<tr><td>User Registration with email verification</td></tr>
<tr><td>User Password Reset via Email Token</td></tr>
<tr><td>User Login with remember password</td></tr>
<tr><td>User Roles/ACL Implementation</td></tr>
</table>

<h4><a href="#compatiable"></a>Compatibility</h4>
Package is compatible with:<br>
    <pre>python >=3.6</pre>

<h4><a href="#requirements"></a>Requirements</h4>
<blockquote>
<a href="https://maciejkula.github.io/spotlight/" target="_blank">Spotlight</a><br>
<pre>
Laravel style data validation for Python.
</pre>
</blockquote>

<blockquote>
<a href="https://click.palletsprojects.com/en/7.x/" target="_blank">Click</a><br>
<pre>
Click is a Python package for creating beautiful command line interfacesin a composable way with 
as little code as necessary.
</pre>
</blockquote>
<blockquote>
<a href="https://github.com/coleifer/peewee" target="_blank">Peewee</a><br>
<pre>
Peewee is a simple and small ORM. It has few (but expressive) concepts,making it easy 
to learn and intuitive to use.
</pre>
</blockquote>
<h4><a href="#route-list"></a>Route List</h4>
<pre>
Register - <span class="pl-e">'api/register'</span>
Login - <span class="pl-e">'api/login'</span>
Email Verification - <span class="pl-e">'api/email-activation'</span>
Forget Password - <span class="pl-e">'api/forget-password'</span>
Resend Activation Code - <span class="pl-e">'api/resend-activation-code'</span>
Roles-<span class="pl-e">'api/roles[/]?([\d]+)?'</span>
Users-<span class="pl-e">'api/users[/]?([\d]+)?'</span>
Users-<span class="pl-e">'api/users/([\d]+)/([a-z-]+)'</span>
</pre>
<h4><a href="#simple-example"></a>Sample Example</h4>
Importing Login class from to /config/services.php

<pre>
<span class="pl-k">from</span> profilelib.controllers.auth <span class="pl-k">import</span> Login

<span class="pl-k">class</span><span class="pl-e"> UserLogin</span>(<span class="pl-e">Login,AbstractClass</span>):

   <span class="pl-c1">pass</span>

</pre>

<h4><a href="#package-license"></a>Profile package manager License</h4>
Profile package manager License is licensed under the <a href="" target="_blank">MIT</a> license. Enjoy!

<h4><a href="#links"></a>Links</h4>
Releases: https://pypi.org/project/profile-package-manager/