Welcome to Nobinobi Child’s documentation!¶

Contents:

Nobinobi Child¶

Application Child for Nobinobi

Documentation¶

The full documentation is at https://nobinobi-child.readthedocs.io.

Quickstart¶

Install Nobinobi Child:

pip install nobinobi-child

Add it to your settings.py:

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.BasicAuthentication',
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.TokenAuthentication',
    ),
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
        'rest_framework_datatables.renderers.DatatablesRenderer',
    ),
    'DEFAULT_FILTER_BACKENDS': (
        'rest_framework_datatables.filters.DatatablesFilterBackend',
    ),
    'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables.pagination.DatatablesPageNumberPagination',
    'PAGE_SIZE': 50,
}

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'phonenumber_field',
    'crispy_forms',
    'django_extensions',
    'rest_framework',
    'rest_framework.authtoken',
    'rest_framework_datatables',
    'menu',
    'bootstrap_modal_forms',
    'widget_tweaks',
    'django_select2',
    'bootstrap_datepicker_plus',
    'nobinobi_core',
    'nobinobi_staff',
    'nobinobi_child.apps.NobinobiChildConfig',
    ...
)

Add Nobinobi Child’s URL patterns:

from nobinobi_core import urls as nobinobi_core_urls
from nobinobi_staff import urls as nobinobi_staff_urls
from nobinobi_child import urls as nobinobi_child_urls


urlpatterns = [
    ...
    path('', include(nobinobi_core_urls)),
    path('', include(nobinobi_staff_urls)),
    path('', include(nobinobi_child_urls)),
    path('select2/', include('django_select2.urls')),
    ...
]

Features¶

TODO

Running Tests¶

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Development commands¶

pip install -r requirements_dev.txt
invoke -l

Credits¶

Tools used in rendering this package:

Installation¶

At the command line:

$ easy_install nobinobi-child

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv nobinobi-child
$ pip install nobinobi-child

Usage¶

To use Nobinobi Child in a project, add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'nobinobi_child.apps.NobinobiChildConfig',
    ...
)

Add Nobinobi Child’s URL patterns:

from nobinobi_child import urls as nobinobi_child_urls


urlpatterns = [
    ...
    path('', include(nobinobi_child_urls)),
    ...
]

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/prolibre-ch/nobinobi-child/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

Nobinobi Child could always use more documentation, whether as part of the official Nobinobi Child docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/prolibre-ch/nobinobi-child/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up nobinobi-child for local development.

Fork the nobinobi-child repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/nobinobi-child.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv nobinobi-child
$ cd nobinobi-child/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 nobinobi_child tests
$ python setup.py test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/prolibre-ch/nobinobi-child/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_nobinobi_child

Credits¶

Development Lead¶

Florian Alu <alu@prolibre.com>

Contributors¶

None yet. Why not be the first?

History¶

0.1.3 (2020-10-12)¶

Add local in package
Update requirements

0.1.2 (2020-09-22)¶

Fix migrations and support for django 4

0.1.1.1 (2020-09-08)¶

Fix Manifest to add woff woff2 ttf ico
Add in requirements.txt and setup.py -> djangorestframework-datatables==0.5.2

0.1.1 (2020-09-08)¶

Fix manifest to include JSON and change setup.py publish and version system
Update Requirement

0.1.0 (2020-08-28)¶

First release on PyPI.