Skip to content

Commit 446b15a

Browse files
Update README.RST
1 parent 3bc4993 commit 446b15a

File tree

1 file changed

+13
-67
lines changed

1 file changed

+13
-67
lines changed

docs/README.RST

Lines changed: 13 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,29 @@
1+
**What's with the name?**
2+
13
# droughty
24
#### adjective, drought·i·er, drought·i·est.
35
#### dry.
46

5-
[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)
7+
It helps keep your workflow *ah hem* dry
8+
9+
==================
10+
11+
**What is droughty?**
612

713
droughty is an analytics engineering toolkit, helping keep your workflow dry. Current tools are:
814

9-
- lookml - generates a base layer.lkml file with views and explores from a warehouse schema
10-
- dbt-tests - generates a base schema from specified warehouse schemas. Includes standard testing routines
15+
- lookml - generates a lkml with views, explores and measures from a warehouse schema
16+
- dbt - generates a base schema from specified warehouse schemas. Includes standard testing routines
1117
- dbml - generates an ERD based on the warehouse layer of your warehouse. Includes pk, fk relationships
18+
- cube - generates a cube schema including dimensions, integrations and meassures
1219

1320
The purpose of this project is to automate the repetitive, dull elements of analytics engineering in the modern data stack. It turns out this also leads to cleaner projects, less human error and increases the likelihood of the basics getting done...
1421

15-
## Tech
16-
17-
droughty uses a number of open-source projects to work properly:
18-
19-
- [lkml](https://pypi.org/project/lkml/) - This project uses lkml as its base parser - John Temple
20-
- [ruamel.yaml](https://pypi.org/project/ruamel.yaml/) - Yaml parser - Anthon van der Neut
21-
22-
some more generic:
23-
24-
- Pandas
25-
- Python Git
26-
- Click
27-
- Pandas GBQ
28-
- Protobuf
29-
- snowflake_connector_python
30-
31-
##Considerations
32-
33-
You need to run Droughty from a git repo. It uses the Git package to control certain relative dirs
34-
Currently the cli sub-commands have an issue where all they are not mutally exclusive. This needs to be resolved but doesn't impact usage dramatically.
35-
36-
37-
And of course droughty itself is open source with a [public repository][dill]
38-
on GitHub.
39-
40-
## Installation
41-
42-
- pip install droughty
43-
- profile.yaml set-up
44-
45-
46-
## Profile.yaml example
47-
48-
droughty_demo:
49-
50-
host:
51-
52-
key_file: /Users/droughty_user/[key_file]
53-
54-
password:
55-
56-
port:
57-
58-
project_name: example-project
59-
60-
schema_name: analytics_qa
61-
62-
user:
63-
64-
warehouse_name: big_query
65-
66-
test_schemas:
67-
68-
example_dev_staging
69-
70-
example_dev_integration
71-
72-
example_analytics_dev
73-
74-
75-
Droughty depends on a droughty_project.yaml file. There are plans to extend the variables available within a project but for the moment it simply instructs Droughty what profile.yaml project you want to run against.
22+
**ReadTheDocs**
7623

77-
## droughty_project.yaml example
24+
https://droughty.readthedocs.io/en/latest/
7825

79-
profile: droughty_demo
8026

8127
## License
8228

83-
MIT
29+
MIT

0 commit comments

Comments
 (0)