Skip to content

Commit

Permalink
Deployed c5c321c to v0.3.1 with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 9, 2024
1 parent 9e14dbb commit f4b03c6
Show file tree
Hide file tree
Showing 65 changed files with 27,953 additions and 0 deletions.
525 changes: 525 additions & 0 deletions v0.3.1/404.html

Large diffs are not rendered by default.

23 changes: 23 additions & 0 deletions v0.3.1/api/api.md
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
Loading

0 comments on commit f4b03c6

Please sign in to comment.