Skip to content

Commit 812f9eb

Browse files
authored
0.0.1 (#1)
0.0.1
1 parent 2b540dc commit 812f9eb

29 files changed

+1122
-1
lines changed

.coveragerc

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[run]
2+
branch = True
3+
data_file = var/coverage
4+
omit =
5+
tests/*
6+
7+
[report]
8+
; Regexes for lines to exclude from consideration
9+
exclude_also =
10+
; Don't complain about missing debug-only code:
11+
def __repr__
12+
if self\.debug
13+
14+
; Don't complain if tests don't hit defensive assertion code:
15+
raise AssertionError
16+
raise NotImplementedError
17+
18+
; Don't complain if non-runnable code isn't run:
19+
if 0:
20+
if __name__ == .__main__.:
21+
22+
; Don't complain about abstract methods, they aren't run:
23+
@(abc\.)?abstractmethod
24+
25+
ignore_errors = True
26+
27+
[html]
28+
directory = var/coverage_html_report

.github/5578703.png

29.3 KB
Loading

.github/workflows/tests.yaml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Python data-flow Tests
2+
3+
on: [ push ]
4+
5+
jobs:
6+
tests:
7+
8+
runs-on: ubuntu-latest
9+
strategy:
10+
matrix:
11+
python-version: [ "3.10", "3.11", "3.12" ]
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
- name: Set up Python ${{ matrix.python-version }}
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: ${{ matrix.python-version }}
19+
- name: Display Python version
20+
run: python -c "import sys; print(sys.version)"
21+
- name: Install modules
22+
run: pip install -r requirements.txt && pip install -r requirements.dev.txt
23+
- name: Tests
24+
run: PYTHONPATH=. pytest --cov=data_flow --cov-report term
25+
- name: Lint
26+
run: pflake8 mysiar_data_flow/ tests/

.gitignore

+166
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
### Python template
2+
# Byte-compiled / optimized / DLL files
3+
__pycache__/
4+
*.py[cod]
5+
*$py.class
6+
7+
# C extensions
8+
*.so
9+
10+
# Distribution / packaging
11+
.Python
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
cover/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
db.sqlite3
63+
db.sqlite3-journal
64+
65+
# Flask stuff:
66+
instance/
67+
.webassets-cache
68+
69+
# Scrapy stuff:
70+
.scrapy
71+
72+
# Sphinx documentation
73+
docs/_build/
74+
75+
# PyBuilder
76+
.pybuilder/
77+
target/
78+
79+
# Jupyter Notebook
80+
.ipynb_checkpoints
81+
82+
# IPython
83+
profile_default/
84+
ipython_config.py
85+
86+
# pyenv
87+
# For a library or package, you might want to ignore these files since the code is
88+
# intended to run in multiple environments; otherwise, check them in:
89+
# .python-version
90+
91+
# pipenv
92+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
94+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
95+
# install all needed dependencies.
96+
#Pipfile.lock
97+
98+
# poetry
99+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
100+
# This is especially recommended for binary packages to ensure reproducibility, and is more
101+
# commonly ignored for libraries.
102+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
103+
#poetry.lock
104+
105+
# pdm
106+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
107+
#pdm.lock
108+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
109+
# in version control.
110+
# https://pdm.fming.dev/#use-with-ide
111+
.pdm.toml
112+
113+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
114+
__pypackages__/
115+
116+
# Celery stuff
117+
celerybeat-schedule
118+
celerybeat.pid
119+
120+
# SageMath parsed files
121+
*.sage.py
122+
123+
# Environments
124+
.env
125+
.venv
126+
env/
127+
venv/
128+
ENV/
129+
env.bak/
130+
venv.bak/
131+
132+
# Spyder project settings
133+
.spyderproject
134+
.spyproject
135+
136+
# Rope project settings
137+
.ropeproject
138+
139+
# mkdocs documentation
140+
/site
141+
142+
# mypy
143+
.mypy_cache/
144+
.dmypy.json
145+
dmypy.json
146+
147+
# Pyre type checker
148+
.pyre/
149+
150+
# pytype static type analyzer
151+
.pytype/
152+
153+
# Cython debug symbols
154+
cython_debug/
155+
156+
# PyCharm
157+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
158+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
159+
# and can be added to the global gitignore or merged into this file. For a more nuclear
160+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
161+
#.idea/
162+
163+
164+
# data_flow
165+
!mysiar_data_flow/lib
166+
tests/data/*.csv

Makefile

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
venv::
2+
rm -rf venv
3+
python -m venv venv
4+
venv/bin/pip install -U pip
5+
6+
pip::
7+
venv/bin/pip install -r requirements.txt
8+
venv/bin/pip install -r requirements.dev.txt
9+
10+
tests::
11+
PYTHONPATH=. venv/bin/pytest --cov=mysiar_data_flow --cov-report html --cov-report term -rP tests/ -vvv
12+
13+
lint::
14+
venv/bin/pflake8 mysiar_data_flow/ tests/
15+
16+
build::
17+
rm -rf dist
18+
venv/bin/poetry build
19+
20+
21+
upload-test::
22+
$(MAKE) build
23+
venv/bin/python -m twine upload -u $${PYPI_USER} -p $${PYPI_PASS_TEST} --verbose --repository testpypi dist/*
24+
25+
upload::
26+
$(MAKE) build
27+
. venv/bin/activate && python -m twine upload -u $${PYPI_USER} -p $${PYPI_PASS} --verbose dist/*

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
# DataFlow
22

3+
![tests](https://github.com/mysiar-org/python-data-flow/actions/workflows/tests.yaml/badge.svg)
4+
[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
5+
[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
6+
[![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3120/)
7+
8+
39
library to manipulate data
410

11+
## Installation instructions
12+
13+
```sh
14+
pip install mysiar-data-flow
15+
```
16+
517
## DataFlow.DataFrame
6-
work in progress
18+
19+
### Usage
20+
For now check [mysiar_data_flow/data_flow.py](mysiar_data_flow/data_flow.py) file for interface
21+
22+
23+
24+
![work in progress](.github/5578703.png)

mysiar_data_flow/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from .data_flow import DataFlow

0 commit comments

Comments
 (0)