Skip to content

Commit 1ef7b08

Browse files
asmirnov69asmirnov69
authored
Merge pull request #2 from pyjanitor-devs/rdfio-intro
introduction of notebook pyjviz support
2 parents cfadc99 + 0742737 commit 1ef7b08

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+3303
-989
lines changed

‎.gitignore

Lines changed: 144 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,145 @@
1-
*~
1+
# Custom
2+
.vscode/*
3+
test*.xml
4+
*.DS_Store
5+
docs/notebooks
6+
pip-wheel-metadata
7+
8+
# Byte-compiled / optimized / DLL files
9+
__pycache__/
10+
*.py[cod]
11+
*$py.class
12+
13+
# C extensions
14+
*.so
15+
16+
# Distribution / packaging
17+
.Python
218
build/
3-
pyjviz.egg-info/
4-
pyjviz/__pycache__/
5-
pyjviz-test-output/
19+
develop-eggs/
20+
dist/
21+
downloads/
22+
eggs/
23+
.eggs/
24+
lib/
25+
lib64/
26+
parts/
27+
sdist/
28+
var/
29+
wheels/
30+
*.egg-info/
31+
.installed.cfg
32+
*.egg
33+
function_test.ipynb
34+
# PyInstaller
35+
# Usually these files are written by a python script from a template
36+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
37+
*.manifest
38+
*.spec
39+
40+
# Installer logs
41+
pip-log.txt
42+
pip-delete-this-directory.txt
43+
44+
# Unit test / coverage reports
45+
htmlcov/
46+
.tox/
47+
.coverage
48+
.coverage.*
49+
.cache
50+
nosetests.xml
51+
coverage.xml
52+
*.cover
53+
.hypothesis/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
63+
# Flask stuff:
64+
instance/
65+
.webassets-cache
66+
67+
# Scrapy stuff:
68+
.scrapy
69+
70+
# Sphinx documentation
71+
docs/_build/
72+
73+
# PyBuilder
74+
target/
75+
76+
# Jupyter Notebook
77+
.ipynb_checkpoints
78+
79+
# pyenv
80+
.python-version
81+
82+
# celery beat schedule file
83+
celerybeat-schedule
84+
85+
# SageMath parsed files
86+
*.sage.py
87+
88+
# dotenv
89+
.env
90+
91+
# virtualenv
92+
.venv
93+
.venv*/
94+
venv/
95+
env/
96+
ENV/
97+
98+
# Spyder project settings
99+
.spyderproject
100+
.spyproject
101+
102+
# Rope project settings
103+
.ropeproject
104+
105+
# mkdocs documentation
106+
/site
107+
108+
# mypy
109+
.mypy_cache/
110+
111+
# pycharm
112+
.idea/
113+
114+
115+
# Custom
116+
.pytest_cache
117+
118+
# Ingore docs' symbolic link to notebooks
119+
docs/notebooks
120+
docs/*
121+
122+
123+
# Swap
124+
[._]*.s[a-v][a-z]
125+
[._]*.sw[a-p]
126+
[._]s[a-rt-v][a-z]
127+
[._]ss[a-gi-z]
128+
[._]sw[a-p]
129+
130+
# Session
131+
Session.vim
132+
Sessionx.vim
133+
134+
# Temporary
135+
.netrwhist
136+
*~
137+
# Auto-generated tag files
138+
tags
139+
# Persistent undo
140+
[._]*.un~
141+
142+
# Other stuff
143+
*.profraw
144+
/scratch.py
145+
midpoint.csv

‎Makefile

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
SHELL=/bin/bash
2+
ACTIVATE=source activate pyjviz
3+
4+
release:
5+
rm -f dist/*
6+
python setup.py sdist bdist_wheel
7+
twine upload dist/*
8+
9+
# Note to self:
10+
# makefile has not been fully tested.
11+
# DO NOT COMMIT until testing is done.
12+
#
13+
# ALSO, remove this comment once it's tested!!!!!!!!!!!
14+
15+
.PHONY: format test lint docs isort check style notebooks install
16+
17+
format:
18+
@echo "Applying Black Python code formatting..."
19+
pre-commit run black --all-files
20+
21+
test:
22+
@echo "Running test suite..."
23+
pytest -v -n auto --color=yes
24+
25+
lint:
26+
@echo "Checking code formatting..."
27+
pre-commit run flake8 --all-files
28+
29+
lint-src:
30+
@echo "Checking code formatting in pyjviz source dir..."
31+
flake8 --color never pyjviz
32+
33+
docs:
34+
@echo "Building documentation..."
35+
mkdocs build
36+
37+
isort:
38+
@echo "Sorting imports..."
39+
isort --check-only --use-parentheses --trailing-comma --multi-line 3 --line-length 79 .
40+
41+
check: test docs notebooks isort format lint
42+
@echo "checks complete"
43+
44+
style: isort format
45+
@echo "styling complete"
46+
47+
install:
48+
@echo "Creating Conda environment..."
49+
conda env create -f environment-dev.yml
50+
51+
@echo "Installing pyjviz in development mode..."
52+
$(ACTIVATE) && python setup.py develop
53+
54+
@echo "Registering current virtual environment as a Jupyter Python kernel..."
55+
$(ACTIVATE) && python -m ipykernel install --user --name pyjviz-dev --display-name "pyjviz development"
56+
57+
@echo "Installing pre-commit hooks"
58+
$(ACTIVATE) && pre-commit install
59+
60+
compile-requirements:
61+
@echo "pip-compiling requirements files..."
62+
find .requirements -type f -name '*.in' | xargs -I {} sh -c\
63+
'echo "compiling" {} && pip-compile {} --upgrade -q'

‎README.md

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

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/index.md

‎docs/api/test.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Test
2+
3+
<b>Hello</b>
4+
5+
::: pyjviz

‎docs/css/apidocs.css

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/* https://mkdocstrings.github.io/theming/#css-classes */
2+
.doc-property {
3+
border-radius: 15px;
4+
padding: 0 5px;
5+
}
6+
.doc-property-special {
7+
background-color: blue;
8+
color: white;
9+
}
10+
.doc-property-private {
11+
background-color: red;
12+
color: white;
13+
}
14+
.doc-property-property {
15+
background-color: green;
16+
color: white;
17+
}
18+
.doc-property-read-only {
19+
background-color: yellow;
20+
color: black;
21+
}
22+
23+
/* https://mkdocstrings.github.io/handlers/python/#recommended-style-material */
24+
/* Indentation. */
25+
div.doc-contents:not(.first) {
26+
padding-left: 25px;
27+
border-left: 4px solid rgba(230, 230, 230);
28+
margin-bottom: 80px;
29+
}
30+
31+
/* add a keyboard shortcut icon for search bar,
32+
* https://github.com/squidfunk/mkdocs-material/issues/2574#issuecomment-821979698
33+
*/
34+
[data-md-toggle="search"]:not(:checked) ~ .md-header .md-search__form::after {
35+
position: absolute;
36+
top: 0.3rem;
37+
right: 0.3rem;
38+
display: block;
39+
padding: 0.1rem 0.4rem;
40+
color: var(--md-default-bg-color--lighter);
41+
font-weight: bold;
42+
font-size: 0.8rem;
43+
border: 0.05rem solid var(--md-default-bg-color--lighter);
44+
border-radius: 0.1rem;
45+
content: "/";
46+
}
47+
48+
/* prevent selection of chevron in example blocks
49+
* cf. https://mkdocstrings.github.io/recipes/#prevent-selection-of-prompts-and-output-in-python-code-blocks
50+
*/
51+
.highlight .gp, .highlight .go { /* Generic.Prompt, Generic.Output */
52+
user-select: none;
53+
}

‎docs/examples.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Examples
2+
3+
::: examples

0 commit comments

Comments
 (0)