Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jesusenlanet/django-nameko-standalone
Use the django ORM into your nameko microservices
https://github.com/jesusenlanet/django-nameko-standalone
django nameko orm python
Last synced: about 2 months ago
JSON representation
Use the django ORM into your nameko microservices
- Host: GitHub
- URL: https://github.com/jesusenlanet/django-nameko-standalone
- Owner: jesusenlanet
- Archived: true
- Created: 2018-12-15T13:47:06.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-06T02:56:12.000Z (over 3 years ago)
- Last Synced: 2024-09-21T06:05:06.941Z (about 2 months ago)
- Topics: django, nameko, orm, python
- Language: Python
- Homepage: https://pypi.org/project/django-nameko-standalone/
- Size: 9.98 MB
- Stars: 11
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ⛔️ Discontinued ⛔️
# DJANGO NAMEKO STANDALONE
[](https://badge.fury.io/py/django-nameko-standalone) [](https://travis-ci.com/jesusenlanet/django-nameko-standalone)
## Use django into your nameko services
## Requirements
Developed for Python3.6.
Have dependecies of:
* Django==3.0.7
* nameko==2.12.0
## Installation
`pip install django-nameko-standalone`
## Usage
This package setup the django framework to take advantage of the ORM features and some other django features.
`DjangoModels` will load all your apps models into one single space where the models are exposed.
If you have your models into`app1.models` and `app2.models`, your app models will be exposed from one point at your election (i.e. `models` or whatever other variable you inject `DjangoModels`).
You need to specify the DJANGO_NAMEKO_STANDALONE_SETTINGS_MODULE or DJANGO_SETTINGS_MODULE environment variable, if not, a 'settings' file is used by default.
Inject the dependency into the nameko service with the DjangoModels dependency.
Supposing you injected the DjangoModels dependency into the `models` variable, you can use from your procedures like `self.models.MyModel.objects.all()`.
## Configuration
### Django nameko standalone configuration
django-nameko-standalone need the next settings variable to work:
```python
# MANDATORY
DJANGO_NAMEKO_STANDALONE_APPS = ("",)
# OPTIONAL
DJANGO_NAMEKO_STANDALONE_SETTINGS_MODULE = 'my_settings'
# OPTIONAL | DEFAULT
DJANGO_SETTINGS_MODULE = "my_settings"
```
This variable control the applications where to load models.
### Django configuration
To configure the django ORM, just configure it as normally for Django.
The `INSTALLED_APPS` and `SECRET_KEY` settings needs to be defined to make Django work.
```python
# Minimum configuration required to work
DJANGO_NAMEKO_STANDALONE_APPS = ("",)
INSTALLED_APPS = ("",)
SECRET_KEY = ''
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': '',
'USER': '',
'HOST': '',
'PORT': 5432,
}
}
```
## Testing
### Run tests with setup.py
You need to have installed setuptools
```bash
pip install setuptools
```
To test the package run in a shell, it will run the tests using pytest with the interpreter used against the Django version available to install (>=1.11,<=2.2.2).
```bash
python3 setup.py test
```
### Run tests with tox
You need to have install tox
```bash
pip install tox
```
Once satisfied, simply run the tox command
```bash
tox
```
It will run a bunch of tests using python3.6 and multiple django versions
## Example
### Example scafolding
* my_nameko_service
* services.py
* settings.py
* requirements.txt
* app1
* \_\_init\_\_.py
* models.py
* app2
* \_\_init\_\_.py
* models.py
### Example usage
```python
from django_nameko_standalone import DjangoModels
from nameko.rpc import rpc
class NamekoService:
name = "nameko_service"
models = DjangoModels() # Inject the django model dependency
@rpc
def get_items(self, host):
items = self.models.Item.objects.all()
...
```