-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed c5c321c to v0.3.1 with MkDocs 1.6.1 and mike 2.1.3
- Loading branch information
1 parent
9e14dbb
commit f4b03c6
Showing
65 changed files
with
27,953 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# API | ||
|
||
### Basic Usage | ||
|
||
```python | ||
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"]) | ||
``` | ||
|
||
::: projectcard.projectcard | ||
|
||
::: projectcard.io | ||
|
||
::: projectcard.validate |
Oops, something went wrong.