Skip to content

Fix #3

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

Merged
merged 4 commits into from
Dec 13, 2020
Merged

Fix #3

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
582593d
added pipenv
Dec 13, 2020
d58e500
added github action build
Dec 13, 2020
7fbb2c1
udpated readme
Dec 13, 2020
5058371
udpated readme
Dec 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .github/build.yml → .github/workflows/build.yml
View file
Open in desktop
File renamed without changes.
61 changes: 44 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,59 @@
# Python Snippets

These __Python Snippets__ are tested with Python 3.6.x. All snippets are
These __Python Snippets__ are tested with Python 3.7.x. and are
available as Jupyter notebooks (http://jupyter.org/).


## Get started...
To get started create a virtual environment and install the required packages.
## Getting Started
All the required Python packages can be installed with `pipenv`.

- Juypter Notebook
- pandas
- geojson
- beautifulsoup4
- feedparser
- scikit-image
- matplotlib
### Project Setup
First you nee to install `pipenv`.

```bash
$ pip install --user pipenv
```

Install all the required packages

```bash
$ pipenv install --dev
```

### Run the Notebook
You can start `jupyter-lab` to play around with the Juypter notebooks.


```bash
pipenv run jupyter-lab
```

### Run the Tests (nbval)
To test the Jupyter notebooks this project uses [nbval](https://github.com/computationalmodelling/nbval), which is a `py.test`
plugin for validating Jupyter notebooks.

### Conda
The following example shows how to create an environment with _"conda"_
(http://conda.pydata.org/) and Python 3.6 with
the required packages.

This will check all Jupyter notebooks for errors.

```bash
conda create -n py36-ps python=3.6
pipenv run py.test --nbval-lax
```

### Upgrade Python Packages
Check which packages have changed.

source activate py36-ps
```
pipenv update --outdated
```

This will upgrade everything.

```bash
pipenv update
```

```
## CI Build (GitHub Actions)
- ![CI Build](https://github.com/rueedlinger/python-snippets/workflows/CI%20Build/badge.svg)

## The Python Snippets
The Python snippets are organized by topic.
Expand Down