Project Cards represent information about a tranportation infrastructure projects sufficient for usage in a regional travel demand model. This package supports validation and usage of this schema.
Project description
Project Card Data Schema
Project Cards represent information about a tranportation infrastructure projects sufficient for usage in a regional travel demand model. This package supports validation and usage of this schema.
Schema
The ProjectCard schema is represented as a json-schema in the /schema
directory and is documented on the schemas page.
Example Data
Example project cards can be found in the /examples
directory and on the examples page
Basic Usage
This package should generally be used to validate or update project cards.
There is also a limited object model, ProjectCard
which can be used to organize and manage project cards.
Command Line
Validate project card(s) from a directory or specific file path, optionally filtering by a tag.
validate_card card_search_dir --filter_tags ['tag_to_search_for']
Update older project card(s) to current format from a directory or specific file path. Cards should still be validated afterwards.
update_projectcard_schema card_search_dir output_dir
Python API
from projectcard.io import read_cards
# Read in cards from a directory with the tag "Baseline 2030"
project_cards = read_cards(directory, filter_tags=["Baseline2030"])
# Iterate through a deck of cards for validity
for project_name,card in project_cards.items():
print(f"{project_name}: {card.valid}")
# Print out a summary of the card with the project name "4th Ave Busway"
print(project_cards["4th Ave Busway"])
Installation
pip install projectcard
Note: Generally it is not necessary to install the projectcard package as the main purpose of this repository is to maintain the project card schema. Projects that use the package to validate project cards usually include projectcards as a requirement and install it on their own.
Development Environment
-
Fork and clone repo locally
-
Install dependencies
conda install --yes --file requirements.txt
or
pip install -r requirements.txt
- Install from working directory
pip install -e .
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
Built Distribution
Hashes for projectcard-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0323af41e6b1fb6e96f53b459ab2316a48f9fbd8c16a6b7452a5130a0fb08237 |
|
MD5 | 6ae1fb7cfdab488a43ba4c87df975791 |
|
BLAKE2b-256 | 63553d6b5f8909d7b0c6bf4743d5d9217f2e9ad3ef4d89fa07a2a6e518a67a76 |