Skip to content

Commit a5bb539

Browse files
clstaudtclstaudt
committed
Merge branch 'main' into dev
2 parents 835fd6d + 57588d9 commit a5bb539

File tree

10 files changed

+178
-173
lines changed

10 files changed

+178
-173
lines changed

‎AUTHORS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Credits
3+
---
4+
5+
# Development Lead
6+
7+
- Christian Staudt \<<[email protected]>\>
8+
9+
# Contributors
10+
11+
None yet. Why not be the first?

‎AUTHORS.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎CONTRIBUTING.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Contributing
2+
3+
Contributions are welcome, and they are greatly appreciated! Every
4+
little bit helps, and credit will always be given.
5+
6+
You can contribute in many ways:
7+
8+
# Types of Contributions
9+
10+
## Report Bugs
11+
12+
Report bugs at <https://github.com/tuttle-dev/tuttle/issues>.
13+
14+
If you are reporting a bug, please include:
15+
16+
- Your operating system name and version.
17+
- Any details about your local setup that might be helpful in
18+
troubleshooting.
19+
- Detailed steps to reproduce the bug.
20+
21+
## Fix Bugs
22+
23+
Look through the GitHub issues for bugs. Anything tagged with \"bug\"
24+
and \"help wanted\" is open to whoever wants to implement it.
25+
26+
## Implement Features
27+
28+
Look through the GitHub issues for features. Anything tagged with
29+
\"enhancement\" and \"help wanted\" is open to whoever wants to
30+
implement it.
31+
32+
## Write Documentation
33+
34+
tuttle could always use more documentation, whether as part of the
35+
official tuttle docs, in docstrings, or even on the web in blog posts,
36+
articles, and such.
37+
38+
## Submit Feedback
39+
40+
The best way to send feedback is to file an issue at
41+
<https://github.com/tuttle-dev/tuttle/issues>.
42+
43+
If you are proposing a feature:
44+
45+
- Explain in detail how it would work.
46+
- Keep the scope as narrow as possible, to make it easier to
47+
implement.
48+
- Remember that this is a volunteer-driven project, and that
49+
contributions are welcome :)
50+
51+
# Get Started!
52+
53+
Ready to contribute? Here\'s how to set up [tuttle]{.title-ref} for
54+
local development.
55+
56+
1. Fork the [tuttle]{.title-ref} repo on GitHub.
57+
58+
2. Clone your fork locally:
59+
60+
``` shell
61+
$ git clone [email protected]:your_name_here/tuttle.git
62+
```
63+
64+
3. Install your local copy into a virtualenv. Assuming you have
65+
virtualenvwrapper installed, this is how you set up your fork for
66+
local development:
67+
68+
``` shell
69+
$ mkvirtualenv tuttle
70+
$ cd tuttle/
71+
$ python setup.py develop
72+
```
73+
74+
4. Create a branch for local development:
75+
76+
``` shell
77+
$ git checkout -b name-of-your-bugfix-or-feature
78+
```
79+
80+
Now you can make your changes locally.
81+
82+
83+
Install the pre-commit hooks before making your first commit to ensure that you match the code style:
84+
85+
``` shell
86+
$ pre-commit install
87+
```
88+
89+
5. When you\'re done making changes, check that your changes pass
90+
code style checks and the tests:
91+
92+
``` shell
93+
$ pytest
94+
```
95+
96+
97+
6. Commit your changes and push your branch to GitHub:
98+
99+
``` shell
100+
$ git add .
101+
$ git commit -m "Your detailed description of your changes."
102+
$ git push origin name-of-your-bugfix-or-feature
103+
```
104+
105+
7. Submit a pull request through the GitHub website.
106+
107+
# Pull Request Guidelines
108+
109+
Before you submit a pull request, check that it meets these guidelines:
110+
111+
1. The pull request should include tests.
112+
2. If the pull request adds functionality, the docs should be updated.
113+
Put your new functionality into a function with a docstring, and add
114+
the feature to the list in README.rst.
115+
3. The pull request should work for Python 3.8, 3.9, 3.10.
116+
117+
# Tips
118+
119+
To run a subset of tests:
120+
121+
``` shell
122+
$ pytest tests.test_tuttle
123+
```
124+
125+
# Deploying
126+
127+
A reminder for the maintainers on how to deploy. Make sure all your
128+
changes are committed (including an entry in HISTORY.rst). Then run:
129+
130+
``` shell
131+
$ bump2version patch # possible: major / minor / patch
132+
$ git push
133+
$ git push --tags
134+
```
135+
136+
Travis will then deploy to PyPI if tests pass.

‎CONTRIBUTING.rst

Lines changed: 0 additions & 128 deletions
This file was deleted.

‎HISTORY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
subtitle: 0.1.0 (2021-10-27)
3+
title: History
4+
---
5+
6+
- First release on PyPI.

‎HISTORY.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,26 @@ The application provides analysis and forecasting functions on income, expenses,
2626
We develop the solution as a GUI application based on web technologies. Sensitive financial data is processed locally on the end device without central data collection. For data analysis, we rely on open source tools from the Python ecosystem.
2727

2828

29+
## Setup
30+
31+
1. Clone or download the current version from the `main` branch.
32+
33+
2. Install the Python module in development mode:
34+
35+
```shell
36+
$ python setup.py develop
37+
```
38+
39+
3. To verify, run the unit tests:
40+
41+
```shell
42+
$ pytest
43+
```
44+
45+
2946
## Contributing
3047

31-
TBA
48+
Your contributions are welcome. Please follow the [guide (CONTRIBUTING.md)](https://github.com/tuttle-dev/tuttle/blob/main/CONTRIBUTING.md).
3249

3350
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
3451

‎requirements.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,14 @@ tox==3.14.0
77
coverage==4.5.4
88
Sphinx==1.8.5
99
twine==1.14.0
10-
11-
pytest==6.2.4
12-
10+
pytest
1311
pandas
1412
pandera
1513
altair
1614
sqlmodel
1715
pyicloud==0.10.2
1816
fints
1917
ics
20-
pydentic
2118
babel
2219
email-validator
2320
loguru

‎setup.py

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,16 @@
1010
with open("HISTORY.rst") as history_file:
1111
history = history_file.read()
1212

13-
requirements = [
14-
"pandas",
15-
"pandera",
16-
"altair",
17-
"sqlmodel",
18-
"pyicloud",
19-
"loguru",
20-
"pydantic[email]",
21-
"pydentic",
22-
"fints",
23-
"ics",
24-
"babel",
25-
]
13+
with open("requirements.txt") as requirements_file:
14+
requirements = requirements_file.readlines()
15+
2616

2717
dev_requirements = [
2818
"jupyterlab",
2919
"ipywidgets",
3020
]
3121

32-
test_requirements = [
33-
"pytest>=3",
34-
]
22+
test_requirements = []
3523

3624

3725
setup(

0 commit comments

Comments
 (0)