Skip to content

Commit 1064c3f

Browse files
committed
documentation improvements
1 parent 97c0a9e commit 1064c3f

File tree

4 files changed

+46
-7
lines changed

4 files changed

+46
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ _YaST/Zypper (OpenSuse)_ (please refer to the documentation for more detail)
9696
Eager to fetch the very latest updates to PyOWM? Install the development trunk (which might be unstable). Eg on Linux:
9797

9898
```shell
99-
git clone https://github.com/csparpa/pyowm.git
100-
cd pyowm && git checkout develop
101-
pip install -r requirements.txt && python setup.py install
99+
$ git clone https://github.com/csparpa/pyowm.git
100+
$ cd pyowm && git checkout develop
101+
$ pip install -r requirements.txt && python setup.py install
102102
```
103103

104104
## Documentation

readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
python:
2-
version: 3.5
2+
version: 3.7
33

44
requirements_file: dev-requirements.txt

sphinx/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ Usage and Technical Documentation
8787
PyOWM v3 documentation
8888
~~~~~~~~~~~~~~~~~~~~~~
8989

90-
Quick code recipes (work in progress)
91-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
90+
Quick code recipes
91+
^^^^^^^^^^^^^^^^^^
9292
.. toctree::
9393
:maxdepth: 1
9494

sphinx/v3/faq.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,43 @@ Please install PyOWM 2.10 with:
4545
pip2 install pyowm==2.10
4646
```
4747

48-
And find the PyOWM 2.10 documentation [here](https://pyowm.readthedocs.io/en/2.10/)
48+
And find the PyOWM 2.10 documentation [here](https://pyowm.readthedocs.io/en/2.10/)
49+
50+
51+
## ModuleNotFound error upon installing PyOWM development branch from Github
52+
53+
Installation of the (potentially unstable) development trunk used to be like this:
54+
55+
```shell
56+
$ pip install git+https://github.com/csparpa/pyowm.git@develop
57+
```
58+
59+
You would get something like:
60+
61+
```shell
62+
Collecting git+https://github.com/csparpa/pyowm.git@develop
63+
Cloning https://github.com/csparpa/pyowm.git (to revision develop) to /tmp/pip-req-build-_86bl7ty
64+
[......]
65+
ERROR: Command errored out with exit status 1:
66+
command: /home/me/.local/share/virtualenvs/backend-nPPHZqlJ/bin/python -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-req-build-_86bl7ty/setup.py'"'"'; __file__='"'"'/tmp/pip-req-build-_86bl7ty/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base /tmp/pip-pip-egg-info-ww_gs9y3
67+
cwd: /tmp/pip-req-build-_86bl7ty/
68+
Complete output (17 lines):
69+
Traceback (most recent call last):
70+
[......]
71+
File "/tmp/pip-req-build-_86bl7ty/pyowm/commons/tile.py", line 6, in <module>
72+
from pyowm.utils.geo import Polygon
73+
File "/tmp/pip-req-build-_86bl7ty/pyowm/utils/geo.py", line 4, in <module>
74+
import geojson
75+
ModuleNotFoundError: No module named 'geojson'
76+
----------------------------------------
77+
ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.
78+
```
79+
80+
I've realized this way of installing is bad *as it does not install PyOWM's dependencies** along.
81+
Therefore the right way to go is:
82+
83+
```shell
84+
$ git clone https://github.com/csparpa/pyowm.git
85+
$ cd pyowm && git checkout develop
86+
$ pip install -r requirements.txt && python setup.py install
87+
```

0 commit comments

Comments
 (0)