Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
14 changes: 0 additions & 14 deletions .github/workflows/actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,6 @@ jobs:
run: |
pytest test --run-slow

docs:
needs: [test, check-style]
if: ${{ github.ref == 'refs/heads/main' }}
runs-on: ubuntu-latest
steps:
- name: Checkout 🔖
uses: actions/checkout@v3
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONFIG_FILE: mkdocs.yml
REQUIREMENTS: requirements-docs.txt

pypi-release:
needs: [test, check-style]
if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') }}
Expand Down
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
<div align="center">
<img src="https://data-as-code.github.io/dac/img/motto.png" width="450"/>
</div>
# `dac`: A CLI Helper Tool for Data as Code

# `dac`: Data as Code
[Data as Code](https://data-as-code.github.io/docs/) (DaC) is a paradigm of distributing versioned data as code.

Data-as-Code (DaC) `dac` is a tool that supports the distribution of data as (python) code.

<div align="center">
<img src="https://data-as-code.github.io/dac/img/logo.jpg" width="250"/>
</div>
`dac` is a tool that [supports the Producer](https://data-as-code.github.io/docs/#3-use-the-dac-cli-tool).

**IMPORTANT**: Currently the project is in the initial development phase, this is why releases are marked as `0.z.y`.
(following [semantic versioning 2.0.0](https://semver.org/): "Major version zero (0.y.z) is for initial development.
Anything MAY change at any time. The public API SHOULD NOT be considered stable.").
While in this phase, we will denote breaking changes with a minor increase.

## 📔 [User documentation](https://data-as-code.github.io/dac/)
## Quickstart

You can install `dac` as a regular python package

```sh
python -m pip install dac
```

Then use the integrated help to find out its functionalities
```sh
dac --help
```

## Setup development environment (for contributors only)

Expand Down
5 changes: 0 additions & 5 deletions docs/examples.md

This file was deleted.

Binary file removed docs/img/logo.jpg
Binary file not shown.
Binary file removed docs/img/motto.png
Binary file not shown.
80 changes: 0 additions & 80 deletions docs/index.md

This file was deleted.