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 hashes)

Uploaded source

Built Distribution

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

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page