diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index ea23d44..419e019 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,11 +1,10 @@ --- name: CI -on: [push] +on: [push, pull_request] jobs: build: - runs-on: ubuntu-latest strategy: diff --git a/CHANGELOG b/CHANGELOG index c249fa4..01616d0 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -6,12 +6,17 @@ What's new in Dennis :local: -Version 0.9.1: in development -============================= +Version 1.0.0: June 10th, 2022 +============================== -* update versions -* add testing for Python 3.6 -* drop support for Python 3.3 +* b38a678 Drop Python 3.5/3.6; add Python 3.9/3.10 (#122, #123, #124, #125) +* b6d34d7 Redo tarrminal printin' and colorr (#71) + + There's an additional backwards-incompatible change here in which we drop + the ``--color`` and ``--no-color`` arguments from ``dennis-cmd lint``. +* 658f951 Document dubstep (#74) +* adb4ae1 Rework CI so it uses a matrix +* transfer project from willkg to mozilla for ongoing maintenance and support Version 0.9.0: February 2nd, 2017 @@ -35,7 +40,7 @@ Version 0.8.0: January 3rd, 2017 * b0705f4 Clean up pytest code and drop Python 2.6 bits * d27790b Fix th' --varformat flag to alloww nay formats (#83) * 3bf0929 Switch travis sudo flag -* 990c842 Update requirements +* 990c842 Update requirements * 0d00ad4 Add travis supparrt * 528fcc1 Fix support for Python 3.5 (Thanks John Vandenberg!) * 700490d Add Travis CI testing (#88) @@ -134,7 +139,7 @@ Version 0.4.1: May 9th, 2014 **Changes** * 831af1a Fix lint output regarding UnicodeEncodeErrors (#37) - + Version 0.4: May 1st, 2014 ========================== @@ -209,7 +214,7 @@ Version 0.3.5: September 17th, 2013 **Changes** * b432e1b Fix rules default -- Running the linter with the default set of - rules will now include malformed variable linting. + rules will now include malformed variable linting. * 72083f9 Improve detect missing } with python vars * b8f3776 Improve linting docs -- It includes a list of lint rules and what they do. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..498baa3 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,15 @@ +# Community Participation Guidelines + +This repository is governed by Mozilla's code of conduct and etiquette guidelines. +For more details, please read the +[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). + +## How to Report +For more information on how to report violations of the Community Participation Guidelines, please read our '[How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/)' page. + + diff --git a/README.rst b/README.rst index 643e617..833c0ef 100644 --- a/README.rst +++ b/README.rst @@ -2,37 +2,36 @@ Read me ======= -Dennis is a set of utilities for working with PO files to ease -development and improve quality. Translate POT files to find problems -with localization in your code. Lint PO files for common problems like -variable formatting, mismatched HTML, missing variables, etc. +Dennis is a set of utilities for working with PO files to ease development and +improve quality. Translate POT files to find problems with localization in your +code. Lint PO files for common problems like variable formatting, mismatched +HTML, missing variables, etc. -It includes the following subcommands: +``dennis-cmd`` has the following subcommands: -* **lint**: Lints PO and POT files for problems including errors that - can cause your production system to crash and problems in strings that - can lead to poor translations. +* **lint**: Lints PO and POT files for problems including errors that can cause + your production system to crash and problems in strings that can lead to poor + translations. The system allows for defining other variable formats. * **status**: Get a high-level status of a PO file including a list of unstranslated strings. -* **translate**: Translates strings in PO files into something else! - Comes with an HTML extractor (tokenizes strings so that only the text - is translated) and a bunch of translations like Pirate!. +* **translate**: Translates strings in PO files into something else! Comes with + an HTML extractor (tokenizes strings so that only the text is translated) and + a bunch of translations like Pirate!. This is helpful for l10n testing, development, finding unicode/layout problems, amazing your friends, hilarious April 1st shenanigans, etc. Specify the tokenizer/transform pipeline you want to use that combines - things. Zombie? Sure! Shouty Zombie? Ok! Manic shouty Dubstep? Bring - it on! + things. Zombie? Sure! Shouty Zombie? Ok! Manic shouty Dubstep? Bring it on! - This also works on strings passed in as command line arguments and - as stdin---it doesn't have to be a PO file or in a PO format - format. For example, Dennis uses Dennis to translate all Dennis - commit messages into Pirate!. That's how cool Dennis is! + This also works on strings passed in as command line arguments and as + stdin---it doesn't have to be a PO file or in a PO format format. For + example, Dennis uses Dennis to translate all Dennis commit messages into + Pirate!. That's how cool Dennis is! Quick start @@ -67,13 +66,13 @@ Get help:: Project details =============== -:Code: https://github.com/willkg/dennis +:Code: https://github.com/mozilla/dennis :Documentation: https://dennis.readthedocs.io/ -:Issue tracker: https://github.com/willkg/dennis/issues +:Issue tracker: https://github.com/mozilla/dennis/issues :License: BSD 3-clause; see LICENSE file Why is it called Dennis? ======================== -This is how I name my software projects. +This is how @willkg names his software projects. diff --git a/dennis/__init__.py b/dennis/__init__.py index 5f8a961..a9af828 100644 --- a/dennis/__init__.py +++ b/dennis/__init__.py @@ -2,7 +2,7 @@ # Examples: # * 1.0 # * 1.0.dev0 -__version__ = "0.9.1.dev0" +__version__ = "1.0.0.dev0" # Date in 'YYYYMMDD' or '' __releasedate__ = "" diff --git a/dennis/cmdline.py b/dennis/cmdline.py index 30d9f6a..4a24b22 100644 --- a/dennis/cmdline.py +++ b/dennis/cmdline.py @@ -491,7 +491,7 @@ def exception_handler(exc_type, exc_value, exc_tb): click.echo("Please write up a bug report with the specifics so that ") click.echo("we can fix it.") click.echo("") - click.echo("https://github.com/willkg/dennis/issues") + click.echo("https://github.com/mozilla/dennis/issues") click.echo("") click.echo("Here is some information you can copy and paste into the ") click.echo("bug report:") diff --git a/docs/hacking.rst b/docs/hacking.rst index 62f4edd..2659d30 100644 --- a/docs/hacking.rst +++ b/docs/hacking.rst @@ -12,11 +12,9 @@ be interesting to you. Install Dennis and dependencies for development =============================================== -1. Clone the repository from https://github.com/willkg/dennis/ +1. Clone the repository from https://github.com/mozilla/dennis/ 2. Create a virtual environment -3. Run: ``python setup.py develop`` -4. Install some other bits: ``pip install -r requirements-dev.txt`` - +3. Install dev requirements: ``pip install -r requirements-dev.txt`` This should get you up and running. @@ -25,7 +23,7 @@ Helping out =========== The non-exhaustive list of things to do are in the `issue tracker -`_. +`_. If you want to write some code or fix a bug or add some docs or in some way contribute to Dennis, please do so using the following diff --git a/docs/index.rst b/docs/index.rst index de77b87..55dd6c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -67,9 +67,9 @@ Get help:: Project details =============== -:Code: https://github.com/willkg/dennis +:Code: https://github.com/mozilla/dennis :Documentation: https://dennis.readthedocs.io/ -:Issue tracker: https://github.com/willkg/dennis/issues +:Issue tracker: https://github.com/mozilla/dennis/issues :License: BSD 3-clause; see LICENSE file diff --git a/setup.py b/setup.py index 733ed2a..472c264 100644 --- a/setup.py +++ b/setup.py @@ -21,39 +21,38 @@ def get_version(): return re.search(VSRE, version_file, re.M).group(1) +INSTALL_REQUIRES = [ + "polib>=1.0.8", + "click>=6", +] + setup( name="dennis", version=get_version(), description=( - "Utilities for working with PO and POT files to ease development " + "Utilities for working with gettext PO and POT files to ease development " "and improve localization quality" ), long_description=open(READMEFILE).read(), license="Simplified BSD License", + maintainer="Mozilla", author="Will Kahn-Greene", - author_email="willkg@bluesock.org", - keywords="l10n localization PO POT lint translate development", - url="https://github.com/willkg/dennis", + keywords="l10n localization gettext PO POT lint translate development", + url="https://github.com/mozilla/dennis", zip_safe=True, packages=find_packages(), include_package_data=True, - install_requires=[ - "polib>=1.0.8", - "click>=6", - ], + install_requires=INSTALL_REQUIRES, entry_points=""" [console_scripts] dennis-cmd=dennis.cmdline:click_run """, python_requires=">=3.7", classifiers=[ - "Development Status :: 4 - Beta", + "Development Status :: 5 - Production/Stable", "Environment :: Console", "License :: OSI Approved :: BSD License", - "Operating System :: MacOS :: MacOS X", - "Operating System :: POSIX", - "Operating System :: POSIX :: Linux", - "Operating System :: Unix", + "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", @@ -61,5 +60,6 @@ def get_version(): "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3 :: Only", + "Topic :: Software Development :: Localization", ], )