Skip to content

Commit

Permalink
Merge d216a25 into e6b3099
Browse files Browse the repository at this point in the history
  • Loading branch information
idomic committed Feb 2, 2022
2 parents e6b3099 + d216a25 commit a324bf0
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 43 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -35,7 +35,7 @@ Ploomber is the fastest way to build data pipelines ⚡️. Use your favorite ed


<p align="center">
<a href="https://ploomber.readthedocs.io/en/latest/get-started/spec-api-python.html"> <img src="_static/get-started.svg" alt="Get Started"> </a>
<a href="https://docs.ploomber.io/en/latest/get-started/quick-start.html"> <img src="_static/quick-start.svg" alt="Get Started"> </a>
</p>


Expand Down
3 changes: 0 additions & 3 deletions _static/get-started.svg

This file was deleted.

3 changes: 3 additions & 0 deletions _static/quick-start.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions doc/_static/img/get-started.svg

This file was deleted.

3 changes: 3 additions & 0 deletions doc/_static/img/quick-start.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/get-started/index.rst
Expand Up @@ -9,6 +9,6 @@ Get Started
:maxdepth: 2

what-is
install
quick-start
spec-api-python
basic-concepts
28 changes: 0 additions & 28 deletions doc/get-started/install.rst

This file was deleted.

52 changes: 52 additions & 0 deletions doc/get-started/quick-start.rst
@@ -0,0 +1,52 @@
Installation
------------

Using ``pip``
*************

.. code-block:: console
pip install ploomber
Using ``conda``
***************

.. code-block:: console
conda install ploomber -c conda-forge
Get an example
--------------

.. code-block:: console
# ML pipeline example
ploomber examples -n templates/ml-basic -o ml-basic
cd ml-basic
.. code-block:: console
# install dependencies
pip install -r requirements.txt
What we're doing in this section is getting a preconfigured workflow. You can
review the code in your ``local``.

Run ploomber
------------
.. code-block:: console
# run pipeline (output will be available in the output directory)
ploomber build
We just ran the ploomber pipeline, you can change parts of the code and see how it affects *execution time*.
You should go to the ``outputs`` folder that was created and open the HTML report to see the execution results.

What's next?
************

Depends what you want to achieve:
* **Bring your own code!** Check out the tutorial to migrate your code to Ploomber :doc:`../user-guide/refactoring`. <br>
* You can go deeper and build your first python pipeline guide: :doc:`../get-started/spec-api-python`. <br>

You can run **another example** as well
8 changes: 1 addition & 7 deletions doc/index.rst
Expand Up @@ -9,13 +9,7 @@ Ploomber documentation
<div class="container">
<div class="row d-flex justify-content-center">
<div class="col-m">
<a href="get-started/what-is.html"> <img class="index-button" src="_static/img/what-is.svg" alt="What is Ploomber?"> </a>
</div>
<div class="col-m">
<a href="get-started/spec-api-python.html"> <img class="index-button" src="_static/img/get-started.svg" alt="Get Started"> </a>
</div>
<div class="col-m">
<a href="https://mybinder.org/v2/gh/ploomber/binder-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fploomber%252Fprojects%26urlpath%3Dlab%252Ftree%252Fprojects%252Fguides/spec-api-python%252FREADME.ipynb%26branch%3Dmaster" target="_blank" rel="noopener noreferrer"> <img class="index-button" src="_static/img/open-jupyterlab.svg" alt="Open JupyerLab"> </a>
<a href="get-started/quick-start.html"> <img class="index-button" src="_static/img/quick-start.svg" alt="Quick Start"> </a>
</div>
</div>
</div>
Expand Down

0 comments on commit a324bf0

Please sign in to comment.