Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Turn repo in to a python package #2

Merged
merged 3 commits into from
Feb 15, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add initial README
  • Loading branch information
symroe committed Feb 15, 2021
commit f2550e4ab70d15cbe71dff92f79f8f34588f0a7e
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Democracy Club design system

Documentation: https://democracyclub.github.io/design-system/

## Use in 3rd party applications

### Python

The design system can be installed using python package managers like `pip` or `pipenv`:

`pip install git+https://github.com/DemocracyClub/design-system.git@VERSION`

It's strongly recommended to pin to a version tag when using in real world applications.

Once installed, all the assets in the `system` directory will be in your `site-packages` folder. To use access them you can import the design system in to your application and use `DC_SYSTEM_PATH`:

```
import dc_design_system
dc_design_system.DC_SYSTEM_PATH
```

You can use this path when compiling the sass by passing it to the include paths.

At this point you can follow the main usage instructions (TODO) to implement.