Contributing to Scribe-Data

Thank you for your interest in contributing!

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, and in accordance with this project’s code of conduct, other contributors will reciprocate that respect in addressing your issue or assessing changes and features.

If you have questions or would like to communicate with the team, please join us in our public Matrix chat rooms. We’d be happy to hear from you!

Contents

First steps as a contributor

Thank you for your interest in contributing to Scribe-Data! We look forward to welcoming you to the community and working with you to build tools for language learners to communicate effectively :) The following are some suggested steps for people interested in joining our community:

  • Please join the public Matrix chat to connect with the community

    • Matrix is a network for secure, decentralized communication

    • We’d suggest that you use the Element client and Element X for a mobile app

    • The General and Data channels would be great places to start!

    • Feel free to introduce yourself and tell us what your interests are if you’re comfortable :)

  • Read through this contributing guide for all the information you need to contribute

  • Look into issues marked good first issue and the Projects board to get a better understanding of what you can work on

  • Check out our public designs on Figma to understand Scribes’s goals and direction

  • Consider joining our bi-weekly developer sync!

[!NOTE] Those new to Python or wanting to work on their Python skills are more than welcome to contribute! The team would be happy to help you on your development journey :)

Back to top.

Mentorship and Growth

Onboarding and mentoring new members is vital to a healthy open-source community.

We need contributors who are onboarded to gain new skills and take on greater roles by triaging issues, reviewing contributions, and maintaining the project. We also need them to help new contributors to grow as well. Please let us know if you have goals to develop as an open-source contributor and we’ll work with you to achieve them.

We also have expectations about the behavior of those who want to grow with us. Mentorship is earned, not given.

To be blunt, those who are mainly sending AI generated contributions are not demonstrating an interest in growing their skills and are not helping to develop the project. This is not to say that all uses of AI for contributions are bad, but AI should be a tool, not the contributor itself.

Continued constructive contributions, new open issues, and clear communication helps the project. We would be happy to help community members who can make these contributions to expand their skills and take on further responsibilities.

If you like the sound of this, then we look forward to working with you!

Back to top.

Learning the tech stack

Scribe is very open to contributions from people in the early stages of their coding journey! The following is a select list of documentation pages to help you understand the technologies we use.

Docs for those new to programming

Python learning docs

Back to top.

Development environment

The development environment for Scribe-Data can be installed via the following steps:

  1. Fork the Scribe-Data repo, clone your fork, and configure the remotes:

[!NOTE]

Consider using SSH

Alternatively to using HTTPS as in the instructions below, consider SSH to interact with GitHub from the terminal. SSH allows you to connect without a user-pass authentication flow.

To run git commands with SSH, remember then to substitute the HTTPS URL, https://github.com/..., with the SSH one, git@github.com:....

  • e.g. Cloning now becomes git clone git@github.com:<your-username>/Scribe-Data.git

GitHub also has their documentation on how to Generate a new SSH key πŸ”‘

# Clone your fork of the repo into the current directory.
git clone https://github.com/<your-username>/Scribe-Data.git
# Navigate to the newly cloned directory.
cd Scribe-Data
# Assign the original repo to a remote called "upstream".
git remote add upstream https://github.com/scribe-org/Scribe-Data.git

  • Now, if you run git remote -v you should see two remote repositories named:

    • origin (forked repository)

    • upstream (Scribe-Data repository)

  1. Create a virtual environment for Scribe-Data (Python >=3.12), activate it and install dependencies:

[!NOTE] First, install uv if you don’t already have it by following the official installation guide.

```bash
uv sync --all-extras  # create .venv and install all dependencies from uv.lock

# Unix or macOS:
source .venv/bin/activate

# Windows:
.venv\Scripts\activate.bat  # .venv\Scripts\activate.ps1 (PowerShell)
```

After activating the virtual environment, set up prek by running:

prek install
# uv run prek run --all-files  # lint and fix common problems in the codebase

[!NOTE] If you change dependencies in pyproject.toml, regenerate the lock file with the following command:

uv lock  # refresh uv.lock for reproducible installs

[!NOTE] If you are having issues with prek and want to send along your changes regardless, you can ignore the pre-commit hooks via the following:

git commit --no-verify -m "COMMIT_MESSAGE"

If you face any issues, consider reinstalling Scribe-data by running the following:

# Install the new version of Scribe-Data:
pip uninstall scribe-data
pip install -e .  # or pip install scribe-data

# Update the entry_points and console_scripts:
python setup.py egg_info

[!NOTE] Feel free to contact the team in the Data room on Matrix if you’re having problems getting your environment setup!

Back to top.

Testing

In addition to the prek pre-commit hooks that are set up during the development environment section, Scribe-Data also includes a testing suite that should be ran before all pull requests and subsequent commits. Please run the following in the project root:

pytest

Back to top.

Issues and projects

The issue tracker for Scribe-Data is the preferred channel for bug reports, features requests and submitting pull requests. Scribe also organizes related issues into projects.

[!NOTE]
Just because an issue is assigned on GitHub doesn’t mean the team isn’t open to your contribution! Feel free to write in the issues and we can potentially reassign it to you.

Be sure to check the -next release- and -priority- labels in the issues for those that are most important, as well as those marked good first issue that are tailored for first-time contributors.

Back to top.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search to check if the issue has already been reported.

  2. Check if the issue has been fixed by trying to reproduce it using the latest main or development branch in the repository.

  3. Isolate the problem to make sure that the code in the repository is definitely responsible for the issue.

Great Bug Reports tend to have:

  • A quick summary

  • Steps to reproduce

  • What you expected would happen

  • What actually happens

  • Notes (why this might be happening, things tried that didn’t work, etc)

To make the above steps easier, the Scribe team asks that contributors report bugs using the bug report template, with these issues further being marked with the Bug type.

Again, thank you for your time in reporting issues!

Back to top.

Feature requests

Feature requests are more than welcome! Please take a moment to find out whether your idea fits with the scope and aims of the project. When making a suggestion, provide as much detail and context as possible, and further make clear the degree to which you would like to contribute in its development. Feature requests are marked with the Feature type, and can be made using the feature request template.

Back to top.

Pull requests

Good pull requests - patches, improvements and new features - are the foundation of our community making Scribe-Data. They should remain focused in scope and avoid containing unrelated commits. Note that all contributions to this project will be made under the specified license and should follow the coding indentation and style standards (contact us if unsure).

Please ask first before embarking on any significant pull request (implementing features, refactoring code, etc), otherwise you risk spending a lot of time working on something that the developers might not want to merge into the project. With that being said, major additions are very appreciated!

When making a contribution, adhering to the GitHub flow process is the best way to get your work merged:

  1. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  2. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  3. Commit your changes in logical chunks, and please try to adhere to Conventional Commits.

[!NOTE] The following are tools and methods to help you write good commit messages ✨

  1. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull --rebase upstream <dev-branch>

  2. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  3. Open a Pull Request with a clear title and description.

Thank you in advance for your contributions!

Back to top.

Data edits

[!NOTE]
Please see the Wikidata and Scribe Guide for an overview of Wikidata and how Scribe uses it.

Scribe does not accept direct edits to the grammar JSON files as they are sourced from Wikidata. Edits can be discussed and the Scribe-Data queries will be changed and ran before an update. If there is a problem with one of the files, then the fix should be made on Wikidata and not on Scribe. Feel free to let us know that edits have been made by opening an issue and we’ll be happy to integrate them!

Back to top.

Documentation

The documentation for Scribe-Data can be found at scribe-data.readthedocs.io. Documentation is an invaluable way to contribute to coding projects as it allows others to more easily understand the project structure and contribute. Issues related to documentation are marked with the documentation label.

Function Docstrings

Scribe-Data generally follows numpydoc conventions for documenting functions and Python code in general. Function docstrings should have the following format:

def example_function(argument: argument_type) -> return_type:
    """
    An example docstring for a function so others understand your work.

    Parameters
    ----------
    argument : argument_type
        Description of your argument.

    Returns
    -------
    return_value : return_type
        Description of your return value.

    Raises
    ------
    ErrorType
        Description of the error and the condition that raises it.
    """

    ...

    return return_value

Building the Docs

Use the following commands to build the documentation locally:

cd docs
make html

You can then open index.html within docs/build/html to check the local version of the documentation.

Back to top.

Changelog

See the releases for Scribe-Data for an up to date list of versions and their release dates.

Scribe-Data tries to follow semantic versioning, a MAJOR.MINOR.PATCH version where increments are made of the:

  • MAJOR version when we make incompatible API changes

  • MINOR version when we add functionality in a backwards compatible manner

  • PATCH version when we make backwards compatible bug fixes

Emojis for the following are chosen based on gitmoji.

Scribe-Data 6.0.0

✨ Features

♻️ Code Refactoring

Scribe-Data 5.2.0

✨ Features

  • The SPARQL queries for the Scribe-Data CLI are generated by a process that checks the available data via the Wikidata Query Service (#617).

  • Scribe-Data can now be used to generate nine emojis per word instead of just three (#670).

🐞 Bug Fixes

  • The handling of missing language directories in the SQLite conversion process has been dramatically improved to communicate to the user which languages are missing and also alert them that no SQLite databases will be created if no data is available for any of the desired languages.

βœ… Tests

  • Testing for various parts of the CLI was expanded (#623).

  • Local pre-commit hooks are now ran with prek instead of pre-commit.

⬆️ Dependencies

  • Dependencies were updated given dependabot warnings.

  • All dependencies for the package were updated to the highest feasible level.

  • Dependency management was switched over to using uv.

Scribe-Data 5.1.4

🐞 Bug Fixes

  • Allow the convert parser to accept multiple data types (#634).

Scribe-Data 5.1.3

🐞 Bug Fixes

  • Fixed data conversion not handling multiple explicitly passed languages and data types (#632).

Scribe-Data 5.1.2

🐞 Bug Fixes

  • Fixed data conversion not handling multiple explicitly passed languages (#630).

Scribe-Data 5.1.1

🐞 Bug Fixes

  • The path to the contracts was fixed in data filtration to assure that it’s a pathlib.Path value (#627).

βœ… Tests

  • The upgrade functionality of the CLI is now comprehensively tested (#624).

♻️ Code Refactoring

  • The upgrade message instructs the user to use the built in upgrade functionality.

Scribe-Data 5.1.0

✨ Features

  • The upgrade command now upgrades the package via pip rather than bringing down GitHub files and installing them directly.

Scribe-Data 5.0.1

♻️ Code Refactoring

  • The requirement files have been updated to fix package install errors (#621).

⬆️ Dependencies

  • Update minimum Python version to 3.11.

Scribe-Data 5.0.0

✨ Features

  • Scribe-Data now has the ability to download the most recent or a specific Wikidata lexemes dump (#517).

    • The user is prompted to download a dump for calls for all data (#518).

    • Scribe-Data must now use a lexeme dump to download all Wikidata lexeme data (#519).

    • The total command can be ran against a Wikidata lexeme dump (#520, #524).

    • Translations can be parsed from Wikidata dumps (#525).

  • Wikidata SPARQL queries are now autogenerated and maintained via Wikidata dumps (#513).

    • Forms are separated into files based on their identifiers while ignoring maintainer set queries (#575).

    • Queries have been expanded for all languages and data forms based on the Wikidata dump process.

  • The date of last modification for Wikidata lexemes has been added to query and dump parsing outputs (#562).

  • Interactive mode now functions throughout the CLI functionality where the user is presented with options for data extraction.

  • The is now a top level interactive mode command for accessing all Scribe-Data functionality (#523).

  • Repeat forms are combined with vertical bars ("|") as a separator (#544, #573).

  • A workflow has been created to update the emoji data on a regular basis (#542).

  • Resulting data can be filtered based on data contracts (#581).

    • Contracts can be checked against data to assure that they’re valid given the data’s field names (#561).

  • The Wikipedia based autosuggestion functionality is now CLI based instead of using a Jupyter notebook (#206).

🐞 Bug Fixes

  • The version command was fixed to account for cases where the version has a v before it (#534).

  • The functionality to check for current data and prompt its deletion was centralized and messages to the user were made more clear (#336).

  • If Wikidata queries can’t be completed, Scribe-Data now includes dramatically better error messages and directs the user to leverage commands that use Wikidata dumps (#549).

  • General bug fixes for a more fluid developer experience.

βœ… Tests

  • Tests have been written for all new functionalities (#570).

  • CI testing now includes a coverage check that breaks if coverage falls below a given percentage.

πŸ“ Documentation

  • Documentation has been expanded for all functionalities of the CLI.

♻️ Code Refactoring

  • All numpydoc docstrings have been fixed and unneeded code has been removed (#547).

Scribe-Data 4.1.0

✨ Features

  • Queries for noun genders and other properties that require the Wikidata label service now return their English label rather than auto label that was returning just the Wikidata QID.

  • SPARQL queries for English and Portuguese prepositions were added to allow the CLI to query these types of data.

  • The convert functionality once again works for lists of languages all data types for them.

🐞 Bug Fixes

  • SQLite conversion was fixed for all queries (#527).

  • The data conversion process outputs were improved including capitalizing language names and repeat notices to the user were removed.

  • The CLI’s get command now returns all data types if none is passed.

  • The Portuguese verbs query was fixed as it wasn’t formatted correctly.

  • The emoji keyword functionality was fixed given the new lexeme ID based form of the data.

    • Arguments were fixed that were breaking the functionality.

    • Languages for the user were capitalized.

  • case has been renamed grammaticalCase in preposition queries to assure that SQLite reserved keywords are not used.

Scribe-Data 4.0.0

✨ Features

  • Queries for countless data types for countless languages were expanded and added ❀️

  • Scribe-Data is now a fully functional CLI.

    • Querying Wikidata lexicographical data can be done via the get command (#159).

    • The output type of queries can be in JSON, CSV, TSV and SQLite, with converting output types also being possible (#145, #146)

    • Output paths can be set for query results (#144).

    • The version of the CLI can be printed to the command line and the CLI can further be used to upgrade itself (#186, #157 ).

    • Total Wikidata lexemes for languages and data types can be derived with the total command (#147).

    • Interactive and total commands can be used via an interactive mode with the --interactive argument (#158, #203).

    • Outputs were standardized to assure that the CLI experience is consistent

  • The machine translation process has been removed to make way for the Wiktionary based implementation (#292).

  • Package metadata files were standardized for languages, data types and Wikidata lexeme forms.

  • CLI commands have an argument check that can suggest correct languages and data types (#341).

🐞 Bug Fixes

  • Wikidata query process stages no longer trigger the tqdm progress bar when they’re unsuccessful (#155).

βœ… Tests

  • Tests have been written for the CLI to assure that it’s functionality remains consistent.

  • Workflows were created to assure that the Wikidata queries and project structure are consistent to assure package functionality (#339, #357)

    • Project queries and its structure have been updated to match the rules developed for the checks.

πŸ“ Documentation

  • The CLI’s functionality has been fully documented (#152, #208).

  • Documentation was created to show how to write Scribe-Data queries (#395).

♻️ Code Refactoring

  • word_type has been switched to data_type throughout the codebase (#160).

  • Case, gender and annotation utility functions were removed as the formatting process that used them has changed.

  • The SPARQLWrapper access method has been extracted to the Wikidata utils and is imported into the files that need it (#164).

  • Export data paths have been converted to centrally saved variables to reduce hard coded string repetition.

  • Many files were renamed including update_data.py being renamed query_data.py

  • Paths within the package have been updated to work for all operating systems via pathlib (#125).

  • The language formatting scripts have been dramatically simplified given changes to export paths all being the same.

  • The update_files directory was removed in preparation of other means of showing data totals.

  • The language_data_extraction directory was moved under the Wikidata directory as it’s only used for those processes now (#446).

  • The emoji keyword process was centralized to simplify project maintenance (#359).

  • PyICU was removed as a dependency and a process was made to install it and its needed dependencies given the operating system of the user (#196).

  • The data formatting step was centralized such that we only have one for all languages (#142).

  • Sub-query processes are now no longer hard coded such that we’d need to maintain the total possible sub-queries within the query_data.py process.

Scribe-Data 3.3.0

✨ Features

  • The translation process has been updated to allow for translations from non-English languages (#72, #73, #74, #75, #75, #76, #77, #78, #79).

🐞 Bug Fixes

  • Annotation bugs were removed like repeat or empty values.

  • Perfect tenses of Portuguese verbs were fixed via finding the appropriate PID (#68).

    • Note that the most common past perfect property is not the standard one, so this will need to be fixed.

πŸ“ Documentation

  • The documentation has been given a new layout with the logo in the top left (#90).

  • The documentation now has links to the code at the top of each page (#91).

♻️ Code Refactoring

  • pre-commit have been added to the repo to improve the development experience (#137).

  • Code formatting was shifted from black to Ruff.

  • A Ruff based GitHub workflow was added to check the code formatting and lint the codebase on each pull request (#109).

  • The _update_files directory was renamed update_files as these files are used in non-internal manners now (#57).

  • A common function has been created to map Wikidata ids to noun genders (#69).

  • The project now is installed locally for development and command line usage, so usages of sys.path have been removed from files (#122).

  • The directory structure has been dramatically streamlined and includes folders for future projects where language data could come from other sources like Wiktionary (#139).

    • Translation files are moved to their own directory.

    • The extract_transform directory has been removed and all files within it have been moved one level up.

    • The languages directory has been renamed language_data_extraction.

    • All files within wikidata/_resources have been moved to the resources directory.

    • The gender and case annotations for data formatting have now been commonly defined.

    • All language directory formatted_data files have been now moved to the scribe_data_json_export directory to prepare for outputs being required to be directed to a directory outside of the package.

    • Path computing has been refactored throughout the codebase, and unneeded functions for data transfers have been removed.

Scribe-Data 3.2.2

  • Minor fixes to documentation index and file docstrings to fix errors.

  • Revert change to package path definition to hopefully register the resources directory.

Scribe-Data 3.2.1

♻️ Code Refactoring

  • The docs and tests were grafted into the package using MANIFEST.in.

  • Minor fixes to file and function docstrings and documentation files.

  • include_package_data=True is used in setup.py to hopefully include all files in the package distribution.

Scribe-Data 3.2.0

✨ Features

  • The data and process needed for an English keyboard has been added (#39).

    • The Wikidata queries for English have been updated to get all nouns and verbs.

    • Formatting scripts have been written to prepare the queried data and load it into an SQLite database.

  • The data update process has been cleaned up in preparation for future changes to Scribe-Data and to implement better practices.

  • Language data was extracted into a JSON file for more succinct referencing (#52).

  • Language codes are now checked with the package langcodes for easier expansion.

  • A process has been created to check and update words that can be translated for each Scribe language (#44).

  • The baseline data returned from Wikidata queries is now removed once a formatted data file is created.

🐞 Bug Fixes

  • Tensorflow was removed from the download wiki process to fix build problems on Macs.

βœ… Tests

  • A full testing suite has been added to run on GitHub Actions (#37).

  • Unit tests have been added for Wikidata queries (#48) and utility functions (#50).

♻️ Code Refactoring

  • The Anaconda based virtual environment was removed and documentation was updated to reflect this.

  • Language data processes were moved into the src/scribe_data/extract_transform/languages directory to clean up the structure.

  • Code formatting processes were defined with common structures based on language and word type variables defined at the top of files.

Scribe-Data 3.1.0

✨ Features

  • The word β€œScribe” is now added to language database nouns files if it’s not already present (#35).

  • German contracted prepositions have been added to the German prepositions formatting process (#34).

  • Words that are upper case are now better included in the autocomplete lexicon with their lower case equivalents being removed.

  • Words with apostrophes have been removed from the autocomplete lexicon.

♻️ Code Refactoring

  • Database output column names are now zero indexed to better align with Python and other language standards.

Scribe-Data 3.0.0

✨ Features

  • Scribe-Data now has the ability to generate SQLite databases from formatted language data.

    • data_to_sqlite.py is used to read available JSON files and input their information into the databases.

  • These databases are now sent to Scribe apps via defined paths.

    • send_dbs_to_scribe.py finds all available language databases and copies them.

    • Separating this step from the data update is in preparation for data import in the future where this will be an individual step.

  • Scribe-Data now also creates autocomplete lexicons for each language within data_to_sqlite.py.

  • JSON data is no longer able to be uploaded to Scribe app directories directly, with the SQLite directories now being exported instead.

  • Emojis of singular nouns are now also linked to their plural counterparts if the plural isn’t present in the emoji keyword outputs.

  • The emoji process also now updates a column to the data_table.txt file for sharing on readmes with update_data.py maintaining it in the data update process.

🐞 Bug Fixes

  • The statements in translation files have been fixed as they were improperly defined after a file was moved.

♻️ Code Refactoring

  • The Jupyter notebooks for autosuggestions and emojis as well as update_data.py were moved to the extract_transform directory given that they’re not used to load data anymore.

    • Their code was refactored to reflect their new locations.

  • Massive amounts of refactoring happened to achieve the shift in the data export method:

    • format_WORD_TYPE.py files export to a formatted_data directory within extract_transform.

    • Copies of all data JSONs that were originally in Scribe apps are now in the formatted_data directories.

    • Functions in update_utils.py were switched given that data is no longer uploaded into a Data directory within the language keyboard directories within Scribe apps.

    • Lots of functions and variables were renamed to make them more understandable.

    • Code to derive appropriate export locations within format_WORD_TYPE.py files was removed in favor of a language formatted_data directory.

    • regex was added as a dependency.

    • pylint comments were removed.

  • Verb SPARQL query scripts for Spanish and Italian were simplified to remove unneeded repeat conditions (#7).

Scribe-Data 2.2.2

✨ Features

  • An option to remove the is_base and rank sub keys was added.

♻️ Code Refactoring

  • The export filenames for emoji keywords were renamed to reflect their usage in autosuggestions and soon autocompletions as well.

Scribe-Data 2.2.1

✨ Features

  • The number of suggested emojis for words can now be limited.

  • The total number of emojis that suggestions can be made for can now be limited.

Scribe-Data 2.2.0

✨ Features

  • Scribe-Data now allows the user to create JSONs of word-emoji key-value pairs (#24).

Scribe-Data 2.1.0

✨ Features

  • Scribe-Data can now split Wikidata queries into multiple stages to break up those that were too large to run (#21).

Scribe-Data 2.0.0

✨ Features

  • Scribe-Data now has the ability to download Wikipedia dumps of any language (#15).

  • Functions have been added to parse and clean the above dumps (#15).

  • Autosuggestions are generated from the cleaned texts by deriving most common words and those words that most commonly follow them (#15).

  • A query for profane words has been added and integrated into the autosuggest flow to make sure that inappropriate words are not included (#16).

    • The adjectives column has been removed from Scribe data tables until support is offered.

♻️ Code Refactoring

  • The error messages for incorrect args in update_data.py have been updated.

Scribe-Data 1.0.1

✨ Features

  • update_data.py now functions using SPARQLWrapper instead of wikidataintegrator.

🐞 Bug Fixes

  • The data update process has been fixed to work for all queries.

  • Hard coded strings for Spanish formatting files were fixed.

  • The paths of update_data.py were changed to match the new package structure.

Scribe-Data 1.0.0

πŸš€ Deployment

  • Releasing a Python package so that codes are accessible and the structure is set for future project iterations.

✨ Features

  • Data updates are done via a single file that loads new formatted data into each Scribe application.

  • This will be expanded on in the future to create language packs that can be downloaded in app.

πŸ—ƒοΈ Data

  • Data extraction and formatting scripts for each of Scribe’s current languages as well as those with significant data on Wikidata are included.

Languages include: French, German, Italian, Portuguese, Russian, Spanish, and Swedish. Word types include: nouns, verbs, prepositions and translations.

♻️ Code Refactoring

  • The data update process now updates files in Android and Desktop directories if they’re present.

License

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                            Preamble

  The GNU General Public License is a free, copyleft license for
software and other kinds of works.

  The licenses for most software and other practical works are designed
to take away your freedom to share and change the works.  By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.  We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors.  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

  To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights.  Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received.  You must make sure that they, too, receive
or can get the source code.  And you must show them these terms so they
know their rights.

  Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.

  For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software.  For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.

  Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so.  This is fundamentally incompatible with the aim of
protecting users' freedom to change the software.  The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable.  Therefore, we
have designed this version of the GPL to prohibit the practice for those
products.  If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.

  Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary.  To prevent this, the GPL assures that
patents cannot be used to render the program non-free.

  The precise terms and conditions for copying, distribution and
modification follow.

                       TERMS AND CONDITIONS

  0. Definitions.

  "This License" refers to version 3 of the GNU General Public License.

  "Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

  "The Program" refers to any copyrightable work licensed under this
License.  Each licensee is addressed as "you".  "Licensees" and
"recipients" may be individuals or organizations.

  To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy.  The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

  A "covered work" means either the unmodified Program or a work based
on the Program.

  To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy.  Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

  To "convey" a work means any kind of propagation that enables other
parties to make or receive copies.  Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

  An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License.  If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

  1. Source Code.

  The "source code" for a work means the preferred form of the work
for making modifications to it.  "Object code" means any non-source
form of a work.

  A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

  The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form.  A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

  The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities.  However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work.  For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

  The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

  The Corresponding Source for a work in source code form is that
same work.

  2. Basic Permissions.

  All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met.  This License explicitly affirms your unlimited
permission to run the unmodified Program.  The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work.  This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

  You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force.  You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright.  Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

  Conveying under any other circumstances is permitted solely under
the conditions stated below.  Sublicensing is not allowed; section 10
makes it unnecessary.

  3. Protecting Users' Legal Rights From Anti-Circumvention Law.

  No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

  When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

  4. Conveying Verbatim Copies.

  You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

  You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

  5. Conveying Modified Source Versions.

  You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

    b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

    c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

    d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

  A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit.  Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

  6. Conveying Non-Source Forms.

  You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

    a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

    b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

    c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

    d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

    e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

  A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

  A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling.  In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage.  For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product.  A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

  "Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source.  The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

  If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information.  But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

  The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed.  Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

  Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

  7. Additional Terms.

  "Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law.  If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

  When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it.  (Additional permissions may be written to require their own
removal in certain cases when you modify the work.)  You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

  Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

    b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

    c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

    d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

    e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

    f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

  All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10.  If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term.  If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

  If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

  Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

  8. Termination.

  You may not propagate or modify a covered work except as expressly
provided under this License.  Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

  However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

  Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

  Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

  9. Acceptance Not Required for Having Copies.

  You are not required to accept this License in order to receive or
run a copy of the Program.  Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance.  However,
nothing other than this License grants you permission to propagate or
modify any covered work.  These actions infringe copyright if you do
not accept this License.  Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

  10. Automatic Licensing of Downstream Recipients.

  Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License.  You are not responsible
for enforcing compliance by third parties with this License.

  An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations.  If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

  You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License.  For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

  11. Patents.

  A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based.  The
work thus licensed is called the contributor's "contributor version".

  A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version.  For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

  Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

  In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement).  To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

  If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients.  "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

  If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

  A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License.  You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

  Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

  12. No Surrender of Others' Freedom.

  If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all.  For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

  13. Use with the GNU Affero General Public License.

  Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work.  The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.

  14. Revised Versions of this License.

  The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

  Each version is given a distinguishing version number.  If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation.  If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.

  If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

  Later license versions may give you additional or different
permissions.  However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

  15. Disclaimer of Warranty.

  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. Limitation of Liability.

  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

  17. Interpretation of Sections 15 and 16.

  If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS