Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix req and dev readme with protobuf step #184

Closed
wants to merge 4 commits into from
Closed

fix req and dev readme with protobuf step #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7732177
fix req and dev readme with protobuf step
lalmei Mar 25, 2021
a6ef482
fix ubuntu package name
lalmei Mar 30, 2021
6ed653e
Bump version: 0.4.1-dev0 → 0.4.2-dev0
lalmei Mar 30, 2021
914a01b
Merge branch 'mainline' into requirements_and_dev_fixes
lalmei Apr 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 17 additions & 12 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,26 @@ make clean
pip install -r requirements-dev.txt
```

8. Install whylogs in editable mode to the current python environment
8. Install protobuf compiler

- On Mac OS
```
brew install protobuf
```

- On Ubuntu
```
apt install protobuf-compiler
```


9. Install whylogs in editable mode to the current python environment

```
make develop
```

9. (optional) Build and serve documentation
10. (optional) Build and serve documentation

```
make docs
Expand All @@ -80,14 +93,6 @@ make test
```


### Coverage

Coverage can be checked with

```
make coverage
```

### Testing CI locally

you can run local github actions on the ubuntu using https://github.com/nektos/act. Currently you need to build a latest docker image for ubuntu using the following dockerfile
Expand Down Expand Up @@ -143,7 +148,7 @@ make test-all
```
You can keep bumping the local version if you need to (you can't republish a version twice so this is needed).

### 2. Pushing to master branch
### 2. Pushing to mainline branch

* If you are planning to push to `master` branch, please first create a dev version (see the above guide).
**You'll have to bump it to a `beta` version or the build will fail**. You'll need to do this before creating the merge request:
Expand Down Expand Up @@ -182,7 +187,7 @@ make test-all
## Examples
See the `scripts/` directory for some example scripts for interacting with `whylogs-python`

See the `notebooks/` directory for some example notebooks.
See the `examples/notebooks/` directory for some example notebooks.


## Documentation
Expand Down
117 changes: 29 additions & 88 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,77 +1,27 @@
alembic==1.4.1
appdirs==1.4.4
appnope==0.1.2
argh==0.26.2
attrs==20.3.0
azure-core==1.9.0
azure-storage-blob==12.6.0
backcall==0.2.0
argh>=0.26
autoapi>=2.0.1
black==20.8b1
boto3==1.16.28
botocore==1.19.28
certifi==2020.11.8
cffi==1.14.4
cfgv==3.2.0
chardet==3.0.4
boto3==1.16.63
botocore==1.19.63
certifi==2020.12.5
click==8.0.0a1
cloudpickle==1.6.0
colorama==0.4.4
coverage==5.3
cryptography==3.3.2
cycler==0.10.0
scikit-learn==0.24.1
databricks-cli==0.14.1
decorator==4.4.2
distlib==0.3.1
docker==4.4.0
docutils==0.16
entrypoints==0.3
filelock==3.0.12
Flask==1.1.2
fsspec==0.8.4
gitdb==4.0.5
GitPython==3.1.11
gunicorn==20.0.4
identify==1.5.10
idna==2.10
importlib-metadata==3.1.1
iniconfig==1.1.1
coverage==5.4
flake8==3.9.0
freezegun==1.1.0
fsspec==0.8.5
ipykernel==5.3.4
ipython==7.19.0
ipython-genutils==0.2.0
isodate==0.6.0
itsdangerous==1.1.0
jmespath==0.10.0
jupyter-client==6.1.7
jupyter-core==4.7.0
keyring==21.5.0
kiwisolver==1.3.1
Mako==1.1.3
MarkupSafe==1.1.1
marshmallow==3.9.1
marshmallow==3.10.0
matplotlib==3.3.3
mlflow==1.12.1
msrest==0.6.19
mypy-extensions==0.4.3
nodeenv==1.5.0
mlflow==1.13.1
moto==1.3.16
numpy==1.19.4
oauthlib==3.1.0
packaging==20.7
openpyxl==3.0.6
pandas==1.2.1
parso==0.7.1
pathspec==0.8.1
pexpect==4.8.0
pickleshare==0.7.5
Pillow==8.1.1
pkginfo==1.6.1
pluggy==0.13.1
pre-commit==2.9.2
prometheus-client==0.9.0
prometheus-flask-exporter==0.18.1
prompt-toolkit==3.0.8
protobuf==3.15.6
ptyprocess==0.6.0
py==1.10.0
puremagic ==1.10
pyarrow==2.0.0
pycparser==2.20
Pygments==2.7.4
Expand All @@ -80,28 +30,24 @@ pytest==6.1.2
pytest-cov==2.10.1
pytest-runner==5.3
python-dateutil==2.8.1
python-editor==1.0.4
pytz==2020.4
pytz==2020.5
PyYAML==5.4
pyzmq==20.0.0
querystring-parser==1.2.4
readme-renderer==28.0
regex==2020.11.13
requests==2.25.0
requests-oauthlib==1.3.0
requests-toolbelt==0.9.1
rfc3986==1.4.0
s3transfer==0.3.3
s3transfer==0.3.4
scikit-learn==0.24.1
setuptools-black==0.1.5
six==1.15.0
smmap==3.0.4
SQLAlchemy==1.3.20
sqlparse==0.4.1
tabulate==0.8.7
toml==0.10.2
tornado==6.1
smart-open==4.1.2
sphinx-autoapi>=1.4.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we shouldn't have sphinx devs in our dev dependencies. This is for documentation dependencies and they are separate

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i disagree, my understanding is that this was included as a full dependency for a developer working on this project. which what the team has been asking for. otherwise lets just remove this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but agree it shouldn't be part of the main requirements

sphinx-autorun >= 1.1.1
sphinx-gallery >= 0.8.0
sphinx-gitstamp>=0.3.1
sphinx>=2.1
sphinx_autodoc_typehints
sphinx_rtd_theme>=0.4.3
sphinxcontrib-contentui>=0.2.4
sybil>=1.2.1
tqdm==4.54.0
traitlets==5.0.5
tox==3.23.0
twine==3.2.0
typed-ast==1.4.1
typing-extensions==3.7.4.3
Expand All @@ -113,9 +59,4 @@ websocket-client==0.57.0
Werkzeug==1.0.1
whylabs-client==0.1
whylabs-datasketches==2.2.0b1
zipp==3.4.0
puremagic == 1.10
xlrd==2.0.1
openpyxl==3.0.6
tqdm==4.54.0
smart-open==4.1.2
xlrd==2.0.1