Skip to main content

Tools to make the civic.json (extended) specification easy to use.

Project description

civic.json-cli is a command line interface that helps make civic.json easier to use. This tool will let you:

  1. Install a civic.json template to your repository

  2. Validate one that’s already there.

It implements the civic.json (extended) specification, a (backwards compatible) modification to BetaNYC’s original civic.json specification. The update aims to broaden civic.json’s user base to include civic hackers inside and outside of government.

You can read more about that on the civic.json (extended) homepage or in its GitHub repository.

Dependencies

  • Python 2.7 or 3.3+

  • jsonschema to validate civic.json files against the schema

  • requests to get the schema and template files from GitHub and ensure they’re up to date

  • An active internet connection

Use

Create a civic.json file

Run civicjson init from the base directory of your repository to initialize a civic.json file (with explanatory text).

Validate a civic.json file

Run civicjson validate from the folder containing your civic.json file. If there are any errors, it will output them to the console.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

civicjson-0.1.1.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

civicjson-0.1.1-py2.py3-none-any.whl (7.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file civicjson-0.1.1.tar.gz.

File metadata

  • Download URL: civicjson-0.1.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for civicjson-0.1.1.tar.gz
Algorithm Hash digest
SHA256 74a13b7e1f7057dda5341cd6126d42b55dfbc4503c5c1c12c7d15af6748cb4c9
MD5 9fc4bbc7aad104b0a2f4873a6008c7ab
BLAKE2b-256 210c90e835643cea545856a2d551d2aa76b6ffebf516e0803a195ec996ac5bf7

See more details on using hashes here.

File details

Details for the file civicjson-0.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for civicjson-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 10cf708e93eb1060f631bcbb05de4301d4d8e91b3c9a2b0c5e1e92ef218c8ce9
MD5 83cebeb46e562e656f3daf97c7ef2949
BLAKE2b-256 c219da86f17097a20bae95612964b404bb032b6504c9ce88972748dbc90dd8c2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page