README.md

@@ -1,5 +1,3 @@
-# multitenancy
-
 <p align="center">
 <img src="https://banners.beyondco.de/Masonite%20Multitenancy.png?theme=light&packageManager=pip+install&packageName=masonite-multitenancy&pattern=charlieBrown&style=style_2&description=Multitenancy+package+for+masonite.&md=1&showWatermark=1&fontSize=100px&images=adjustments&widths=50&heights=50">
 </p>
@@ -8,16 +6,16 @@
   <a href="https://docs.masoniteproject.com">
     <img alt="Masonite Package" src="https://img.shields.io/static/v1?label=Masonite&message=package&labelColor=grey&color=blue&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAA6gAwAEAAAAAQAAAA4AAAAATspU+QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAnxJREFUKBVNUl1IVEEUPjPObdd1VdxWM0rMIl3bzbVWLSofVm3th0AhMakHHyqRiNSHEAq5b2HSVvoQRUiEECQUQkkPbRslRGigG8auoon2oPSjpev+3PWeZq7eaC5nDt93vplz5txDQJYpNxX4st4JFiwj9aCqmswUFQNS/A2YskrZJPYefkECC2GhQwAqvLYybwXrwBvq8HSNOXRO92+aH7nW8vc/wS2Z9TqneYt2KHjlf9Iv+43wFJMExzO0YE5OKe60N+AOW6OmE+WJTBrg23jjzWxMBauOlfyycsV24F+cH+zAXYUOGl+DaiDxfl245/W9OnVrSY+O2eqPkyz4sVvHoKp9gOihf5KoAVv3hkQgbj/ihG9fI3RixKcUVx7lJVaEc0vnyf2FFll+ny80ZHZiGhIKowWJBCEAKr+FSuNDLt+lxybSF51lo74arqs113dOZqwsptxNs5bwi7Q3q8npSC2AWmvjTncZf1l61e5DEizNn5mtufpsqk5+CZTuq00sP1wkNPv8jeEikVVlJso+GEwRtNs3QeBt2YP2V2ZI3Tx0e+7T89zK5tNASOLEytJAryGtkLc2PcBM5byyUWYkMQpMioYcDcchC6xN220Iv36Ot8pV0454RHLEwmmD7UWfIdX0zq3GjMPG5NKBtv5qiPEPekK2U51j1451BZoc3i+1ohSQ/UzzG5uYFFn2mwVUnO4O3JblXA91T51l3pB3QweDl7sNXMyEjbguSjrPcQNmwDkNc8CbCvDd0+xCC7RFi9wFulD3mJeXqxQevB4prrqgc0TmQ85NG/K43e2UwnMVAJIEBNfWRYR3HfnvivrIzMyo4Hgy+hfscvLo53jItAAAAABJRU5ErkJggg==">
   </a>
-  <img alt="GitHub Workflow Status (branch)" src="https://img.shields.io/github/workflow/status/yubarajshrestha/multitenancy/Test%20Application">
-  <img src="https://codecov.io/gh/yubarajshrestha/multitenancy/branch/main/graph/badge.svg?token="/>
-  <img alt="PyPI" src="https://img.shields.io/pypi/v/multitenancy">
+  <img alt="GitHub Workflow Status (branch)" src="https://github.com/yubarajshrestha/masonite-multitenancy/actions/workflows/pythonapp.yml/badge.svg">
+  <img src="https://codecov.io/gh/yubarajshrestha/masonite-multitenancy/branch/main/graph/badge.svg?token="/>
+  <img alt="PyPI" src="https://img.shields.io/pypi/v/masonite-multitenancy">
   <img src="https://img.shields.io/badge/python-3.6+-blue.svg" alt="Python Version">
-  <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/yubarajshrestha/multitenancy?include_prereleases">
-  <img alt="License" src="https://img.shields.io/github/license/yubarajshrestha/multitenancy">
+  <img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/yubarajshrestha/masonite-multitenancy?include_prereleases">
+  <img alt="License" src="https://img.shields.io/github/license/yubarajshrestha/masonite-multitenancy">
   <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 </p>
 
-## Introduction
+# Masonite Multitenancy (WIP)
 
 Multitenancy package for Masonite!
 
@@ -71,6 +69,48 @@ This will prompt few questions just provider answers and that's it.
 python craft tenancy:create
 ```
 
+> Note: After creating a new tenant, you will need to setup related database configuration in `config/multitenancy.py`.
+
+For example, if your tenant database name is `tenant1`, then you need to add the following to `config/multitenancy.py`:
+
+```python
+# config/multitenancy.py
+
+TENANTS = {
+  "tenant1": {
+    "driver": "sqlite",
+    "database": env("SQLITE_DB_DATABASE", "tenant1.sqlite3"),
+    "prefix": "",
+    "log_queries": env("DB_LOG"),
+  },
+}
+```
+
+You can use any database driver that Masonite supports. For example, if you want to use MySQL, then you can use the following:
+
+```python
+# config/multitenancy.py
+
+TENANTS = {
+  "tenant1": {
+    "driver": "mysql",
+    "host": env("DB_HOST"),
+    "user": env("DB_USERNAME"),
+    "password": env("DB_PASSWORD"),
+    "database": env("DB_DATABASE"),
+    "port": env("DB_PORT"),
+    "prefix": "",
+    "grammar": "mysql",
+    "options": {
+        "charset": "utf8mb4",
+    },
+    "log_queries": env("DB_LOG"),
+  },
+}
+```
+
+> Note: Make sure you have set the `multitenancy` configuration before running any tenant related commands.
+
 **List all tenants**
 
 ```bash
@@ -138,15 +178,15 @@ Route.get("/tenant-aware-routes", "WelcomeController@show").middleware("multiten
 In above example, `/tenant-aware-routes` will be tenant aware. It means that if you have tenant setup and you are trying to access `/tenant-aware-routes` then you will get tenant specific items from the database.
 
 
-## Contributing
+### Contributing
 
 Please read the [Contributing Documentation](CONTRIBUTING.md) here.
 
-## Maintainers
+### Maintainers
 
 - [x] [Yubaraj Shrestha](https://www.github.com/yubarajshrestha)
 
-## License
+### License
 
 
 multitenancy is open-sourced software licensed under the [MIT license](LICENSE).

setup.py

@@ -8,7 +8,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version="0.0.1",
+    version="0.0.2",
     packages=[
         "multitenancy",
         "multitenancy.commands",