File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 5757 run : |
5858 pytest test --run-slow
5959
60- docs :
61- needs : [test, check-style]
62- if : ${{ github.ref == 'refs/heads/main' }}
63- runs-on : ubuntu-latest
64- steps :
65- - name : Checkout π
66- uses : actions/checkout@v3
67- - name : Deploy docs
68- uses : mhausenblas/mkdocs-deploy-gh-pages@master
69- env :
70- GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
71- CONFIG_FILE : mkdocs.yml
72- REQUIREMENTS : requirements-docs.txt
73-
7460 pypi-release :
7561 needs : [test, check-style]
7662 if : ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') }}
Original file line number Diff line number Diff line change 1- <div align =" center " >
2- <img src =" https://data-as-code.github.io/dac/img/motto.png " width =" 450 " />
3- </div >
1+ # ` dac ` : A CLI Helper Tool for Data as Code
42
5- # ` dac ` : Data as Code
3+ [ Data as Code ] ( https://data-as-code.github.io/docs/ ) (DaC) is a paradigm of distributing versioned data as code.
64
7- Data-as-Code (DaC) ` dac ` is a tool that supports the distribution of data as (python) code.
8-
9- <div align =" center " >
10- <img src =" https://data-as-code.github.io/dac/img/logo.jpg " width =" 250 " />
11- </div >
5+ ` dac ` is a tool that [ supports the Producer] ( https://data-as-code.github.io/docs/#3-use-the-dac-cli-tool ) .
126
137** IMPORTANT** : Currently the project is in the initial development phase, this is why releases are marked as ` 0.z.y ` .
148(following [ semantic versioning 2.0.0] ( https://semver.org/ ) : "Major version zero (0.y.z) is for initial development.
159Anything MAY change at any time. The public API SHOULD NOT be considered stable.").
1610While in this phase, we will denote breaking changes with a minor increase.
1711
18- ## π [ User documentation] ( https://data-as-code.github.io/dac/ )
12+ ## Quickstart
13+
14+ You can install ` dac ` as a regular python package
15+
16+ ``` sh
17+ python -m pip install dac
18+ ```
19+
20+ Then use the integrated help to find out its functionalities
21+ ``` sh
22+ dac --help
23+ ```
1924
2025## Setup development environment (for contributors only)
2126
Load Diff This file was deleted.
Load Diff This file was deleted.
You canβt perform that action at this time.
0 commit comments