Skip to content

Commit 1f53c96

Browse files
committed
Initial commit
0 parents  commit 1f53c96

File tree

5 files changed

+688
-0
lines changed

5 files changed

+688
-0
lines changed

Diff for: LICENCE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 TextQL
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: README.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Project Name
2+
3+
Short project description goes here. Explain what your project does and its main features.
4+
5+
## Table of Contents
6+
7+
- [Installation](#installation)
8+
- [Usage](#usage)
9+
- [Documentation](#documentation)
10+
- [Contributing](#contributing)
11+
- [License](#license)
12+
13+
## Installation
14+
15+
To install the package, run the following command:
16+
17+
```bash
18+
pip install dbt-doc-py
19+
```
20+
21+
## Usage
22+
Place inside of the DBT project folder and run this command:
23+
24+
```
25+
dby-doc.py
26+
```
27+
28+
You can execute it from other directories, this way:
29+
30+
```
31+
dby-doc.py --working_directory /folder/DBTproject
32+
```
33+
34+
TO-DO: Finish README file:
35+
36+
## Documentation
37+
38+
39+
## Contributing
40+
41+
42+
## License
43+
This project is licensed under the MIT License. See the LICENSE file for details.

Diff for: dbt-doc-py/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)