Skip to content

Commit

Permalink
Removed vsketch from install_requires. User will have to install it m…
Browse files Browse the repository at this point in the history
…anually if they want to use plotter mode, but its not required.
  • Loading branch information
marceloprates committed Jul 2, 2024
1 parent f4aab1a commit f0bb0a2
Show file tree
Hide file tree
Showing 14 changed files with 55 additions and 58 deletions.
37 changes: 16 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,17 @@ This work is [licensed](LICENSE) under a GNU Affero General Public License v3.0

# Installation

OBS. I'm trying to solve a dependency issue with [vsketch](https://vsketch.readthedocs.io/en/latest/install.html) before publishing prettymaps v0.1.3, so, for now, please install directly from GitHub.
To enable plotter mode:

```
pip install git+https://github.com/abey79/[email protected]
```

### Install locally:
Install prettymaps with:

```
pip install git+https://github.com/marceloprates/prettymaps
pip install prettymaps
```

### Install on Google Colaboratory:
Expand All @@ -62,17 +66,14 @@ prettymaps.plot(your_query)


```python
%load_ext autoreload
%autoreload 2

import prettymaps

plot = prettymaps.plot('Stad van de Zon, Heerhugowaard, Netherlands')
```



![png](README_files/README_7_0.png)
![png](README_files/README_8_0.png)



Expand All @@ -92,7 +93,7 @@ plot = prettymaps.plot(



![png](README_files/README_9_0.png)
![png](README_files/README_10_0.png)



Expand Down Expand Up @@ -364,7 +365,7 @@ plot = prettymaps.plot(



![png](README_files/README_15_0.png)
![png](README_files/README_16_0.png)



Expand All @@ -385,7 +386,7 @@ plot = prettymaps.plot(



![png](README_files/README_17_0.png)
![png](README_files/README_18_0.png)



Expand Down Expand Up @@ -763,7 +764,7 @@ plot.geodataframes['building'][



![svg](README_files/README_21_1.svg)
![svg](README_files/README_22_1.svg)



Expand Down Expand Up @@ -804,7 +805,7 @@ for ax,building in zip(np.concatenate(axes),buildings):



![png](README_files/README_23_0.png)
![png](README_files/README_24_0.png)



Expand All @@ -831,7 +832,7 @@ _ = plot.ax.set_title(



![png](README_files/README_25_0.png)
![png](README_files/README_26_0.png)



Expand All @@ -853,7 +854,7 @@ plot = prettymaps.plot(



![png](README_files/README_27_0.png)
![png](README_files/README_28_0.png)



Expand All @@ -873,12 +874,6 @@ plot = prettymaps.plot(
```



![png](README_files/README_29_0.png)




```python
import prettymaps

Expand All @@ -890,7 +885,7 @@ plot = prettymaps.plot(



![png](README_files/README_30_0.png)
![png](README_files/README_31_0.png)



Expand Down Expand Up @@ -1170,7 +1165,7 @@ plot = prettymaps.multiplot(



![png](README_files/README_36_0.png)
![png](README_files/README_37_0.png)



Expand Down
Binary file added README_files/README_10_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified README_files/README_16_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README_files/README_18_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions README_files/README_22_1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified README_files/README_24_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified README_files/README_26_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified README_files/README_28_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README_files/README_31_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added README_files/README_37_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified README_files/README_8_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 21 additions & 26 deletions notebooks/examples.ipynb

Large diffs are not rendered by default.

8 changes: 7 additions & 1 deletion prettymaps/draw.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import re
import os
import json
import vsketch
import pathlib
import warnings
import matplotlib
Expand Down Expand Up @@ -47,6 +46,13 @@
box,
)

try:
import vsketch
except:
warnings.warn(
'Install Vsketch with "pip install git+https://github.com/abey79/[email protected]" to enable pen plotter mode.'
)


class Subplot:
"""
Expand Down
20 changes: 10 additions & 10 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from setuptools import setup, find_packages

parent_dir = Path(__file__).resolve().parent
presets_dir = os.path.abspath(os.path.join(os.path.pardir, 'presets'))
presets_dir = os.path.abspath(os.path.join(os.path.pardir, "presets"))

setup(
name="prettymaps",
Expand All @@ -15,16 +15,16 @@
author="Marcelo Prates",
author_email="[email protected]",
license="MIT License",
packages=find_packages(
exclude=("assets", "notebooks", "prints", "script")),
install_requires=parent_dir.joinpath(
"requirements.txt").read_text().splitlines() + [
'vsketch @ git+https://github.com/abey79/[email protected]'
],
packages=find_packages(exclude=("assets", "notebooks", "prints", "script")),
install_requires=parent_dir.joinpath("requirements.txt")
.read_text()
.splitlines(), # + [
#'vsketch @ git+https://github.com/abey79/[email protected]'
# ],
classifiers=[
"Intended Audience :: Science/Research",
],
package_dir={'prettymaps': 'prettymaps'},
package_data={'prettymaps': ['presets/*.json']},
python_requires = '>=3.11',
package_dir={"prettymaps": "prettymaps"},
package_data={"prettymaps": ["presets/*.json"]},
python_requires=">=3.11",
)

0 comments on commit f0bb0a2

Please sign in to comment.