v1.0.0b docs updates #777
v1.0.0b docs updates #777
Conversation
V1.x docs kuviz
README.rst
Outdated
| - Use CARTO's spatially-enabled database for analysis | ||
| - Create customizable, interactive CARTO maps in a Jupyter notebook using DataFrames or hosted data | ||
| - Augment your data with CARTO's Data Observatory | ||
| - Use CARTO for cloud-based analysis | ||
| - Try it out without needing a CARTO account by using the `Examples functionality <https://cartoframes.readthedocs.io/en/latest/#module-cartoframes.examples>`__ |
There was a problem hiding this comment.
Nope, changing it
README.rst
Outdated
|
|
||
| If you do not have an API key, you can use the `Example Context <https://cartoframes.readthedocs.io/en/latest/#module-cartoframes.examples>`__ to read the example data, make maps, and run arbitrary queries from the datasets there. The best place to get started is in the "Example Datasets" notebook found when running binder or downloading from the `examples <https://github.com/CartoDB/cartoframes/blob/master/examples/Example%20Datasets.ipynb>`__ directory in the cartoframes GitHub repository. | ||
| If you do not have an API key, you can still use cartoframes for creating maps locally. | ||
|
|
||
| .. note:: | ||
| The example context only provides read access, so not all cartoframes features are available. For full access, `Start a free 30 day trial <https://carto.com/signup>`__ or get free access with a `GitHub Student Developer Pack <https://education.github.com/pack>`__. |
|
|
||
| .. image:: https://raw.githubusercontent.com/CartoDB/cartoframes/master/docs/img/read_demo.gif | ||
| .. image:: https://raw.githubusercontent.com/CartoDB/cartoframes/master/docs/img/data-workflow.gif |
There was a problem hiding this comment.
It's added, but this link won't work until this is all merged into master. I think this isn't the best way to point to images, but I'll see if I can find a better way. The problem is that the README needs to work both in the github repo and the readthedocs site.
README.rst
Outdated
|
|
||
| .. image:: https://raw.githubusercontent.com/CartoDB/cartoframes/master/docs/img/read_demo.gif | ||
| .. image:: https://raw.githubusercontent.com/CartoDB/cartoframes/master/docs/img/data-workflow.gif | ||
|
|
||
| Write an existing pandas DataFrame to CARTO. |
There was a problem hiding this comment.
This cc.write example is covered with the previous one (d.upload), right?
There was a problem hiding this comment.
Correct! Removing :)
There was a problem hiding this comment.
It also made me look at the upload example and realize I made some mistakes
| try out that code, install `cartoframes` as: | ||
|
|
||
| `pip install git+https://github.com/cartodb/cartoframes.git@add-legends-v1#egg=cartoframes` | ||
|
|
||
| Data Observatory | ||
| ---------------- |
There was a problem hiding this comment.
We can move the Credentials class to cartoframes.auth so we can update the section CARTO Credential Management
There was a problem hiding this comment.
👍 I don't mind doing that in this PR but seems like it might be a good idea to do in another one. Just created an issue: #795
| } | ||
|
|
||
| Map( | ||
| Layer('table in your account'), | ||
| basemap | ||
| ) | ||
|
|
||
| Color basemap style. | ||
| Remove basemap and show a custom color. |
There was a problem hiding this comment.
We can remove the basemaps import from Mapbox and custom basemap examples.
cartoframes/viz/map.py
Outdated
| ) | ||
|
|
||
| basemap = { | ||
| 'style': 'mapbox://styles/mapbox/streets-v9', | ||
| 'token: '<your mapbox token>' | ||
| 'token: 'your Mapbox token' |
cartoframes/viz/map.py
Outdated
|
|
||
| .. code:: | ||
|
|
||
| from cartoframes.viz import Map, Layer, basemaps |
|
Looks great! https://cartoframes.readthedocs.io/en/v1.x-docs/index.html for main docs page, and https://cartoframes.readthedocs.io/en/v1.x-docs/py-modindex.html for modules |
Ref #756