Welcome to Django Script Codes (ISO 15924)’s documentation!

Contents:

Django Script Codes (ISO 15924)

Application providing access to the script codes standard ISO 15924.

Documentation

The full documentation is at https://django-script-codes.readthedocs.io.

Quickstart

Install Django Script Codes (ISO 15924):

pip install django-script-codes

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'script_codes.apps.ScriptCodesConfig',
    ...
)

To reference Script Codes in your models:

from django.db import models
from script_codes.models import Script


class MyModel(models.Model):
    ...
    script = models.ForeignKey(Script, on_delete=models.CASCADE)
    ...
]

Features

• TODO

Running Tests

Does the code actually work?

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

Credits

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-djangopackage

Installation

At the command line:

$ easy_install django-script-codes

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django-script-codes
$ pip install django-script-codes

Usage

To use Django Script Codes (ISO 15924) in a project, add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'script_codes.apps.ScriptCodesConfig',
    ...
)

To reference Script Codes in your models:

from django.db import models
from script_codes.models import Script


class MyModel(models.Model):
    ...
    script = models.ForeignKey(Script, on_delete=models.CASCADE)
    ...
]

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/kingsdigitallab/django-script-codes/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

Django Script Codes (ISO 15924) could always use more documentation, whether as part of the official Django Script Codes (ISO 15924) 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/kingsdigitallab/django-script-codes/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 django-script-codes for local development.

1. Fork the django-script-codes repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/django-script-codes.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv django-script-codes
   $ cd django-script-codes/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 script_codes tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. 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
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

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

1. The pull request should include tests.
2. 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.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/kingsdigitallab/django-script-codes/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_script_codes

Credits

Development Lead

• Miguel Vieira <jmvieira@gmail.com>

Contributors

None yet. Why not be the first?

History

0.1.0 (2018-11-02)

• First release on PyPI.