furo theme

franaudo · franaudo · commit 307de0ec243c · 2021-11-03T20:08:21.000+01:00
diff --git a/docs/_static/logo.jpeg b/docs/_static/logo.jpeg
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/examples/drivebot.rst b/docs/examples/drivebot.rst
@@ -0,0 +1,22 @@
+********************************************************************************
+Use DriveBot to upload a document to your Google Drive
+********************************************************************************
+
+This example shows how to instantiate a `drivebot` authenticating through a web
+interface and upload a simple document.
+
+
+Configuration
+-------------
+The first time you use a `DriveBot` you probably want to use a web interface to
+authenticate. If you save your credentials (this will be saved in the `.tokens`
+folder) you don't have to do it again: just set `authentication='local` when you
+instantiate your bot.
+
+In action
+---------
+
+this is an example implementation:
+
+.. literalinclude:: /../examples/drivebot.py
+    :language: python
diff --git a/docs/examples/latexbot_cli.rst b/docs/examples/latexbot_cli.rst
@@ -0,0 +1,72 @@
+********************************************************************************
+use :code:`latexbot` from the command-line
+********************************************************************************
+
+:code:`latexbot` helps you to set-up your machine to work with latex. The first
+step is to install everything you need. Instead of you spending time doing that
+let it do it. Later we will see how to convert documents and connect your
+overleaf project to your google drive.
+
+Basics
+======
+
+For detailed information about the different comands, type :code:`latexbot --help`:
+
+.. code-block:: bash
+    :emphasize-lines: 1
+
+    >>> latexbot --help
+
+    Usage: latexbot [OPTIONS] COMMAND [ARGS]...
+
+    bot to help with latex documents
+
+    Options:
+    --help  Show this message and exit.
+
+    Commands:
+    configure                 Download dependencies and set everything up.
+    convert-overleaf-to-docx  Convert an overleaf project to a .docx file.
+    convert-tex-to-docx       Convert the .tex files in a folder to .docx.
+
+
+Install dependencies
+====================
+
+:code:`latexbot` needs to know what you need. If your are new to this, probably
+you will need everything.
+
+Run the following command:
+
+.. code-block:: bash
+    :emphasize-lines: 1
+
+    >>> latexbot configure --git=True --pandoc=True --miktex=True
+
+
+Convert a latex document to docx
+================================
+
+This command uses `pandoc` in the background. This software is prettty awesome,
+but don't expect the conversion to be 100% perfect...
+
+.. code-block:: bash
+    :emphasize-lines: 1
+
+    >>> latexbot convert-tex-to-docx --input "C:\temp\...\my_tex_file.tex" --output= "C:\temp\...\my_folder"
+
+Convert an overleaf project to google doc
+=========================================
+
+Here we do even more: we get a project from overleaf and convert it directly to
+google doc, were you can use all the fancy collaboration/commenting features.
+
+.. note::
+
+    remember to change the XXXXXXXXXX placeholder with a code of your oveleaf
+    project.
+
+.. code-block:: bash
+    :emphasize-lines: 1
+
+    >>> latexbot convert-overleaf-to-docx XXXXXXXXXX --upload=True
diff --git a/docs/examples/latexbot_install.rst b/docs/examples/latexbot_install.rst
@@ -0,0 +1,15 @@
+********************************************************************************
+Install all you need for latex
+********************************************************************************
+
+This example shows how simple it is to install all the software you need to get
+started with latex, overleaf and all the other cool features of `latexbot`
+
+
+In action
+---------
+
+this is an example implementation:
+
+.. literalinclude:: /../examples/latexbot_install.py
+    :language: python
diff --git a/docs/examples/latexbot_overleaf.rst b/docs/examples/latexbot_overleaf.rst
@@ -0,0 +1,19 @@
+********************************************************************************
+Connect overleaf and google docs
+********************************************************************************
+
+Let's be honest...most people don't use latex and they want to get your document
+in a simple format as Google Doc. Let's be even more honest...if you landed here
+you are nerd and you are probaly using overleaf to write in latex.
+
+How do you connect the two?! I guess by now you know the answer...there is a bot
+for it: `latexbot`
+
+
+In action
+---------
+
+this is an example implementation:
+
+.. literalinclude:: /../examples/latexbot_overleaf.py
+    :language: python
diff --git a/docs/examples/telegrambot.rst b/docs/examples/telegrambot.rst
@@ -45,7 +45,7 @@ some function completion). This is an example implementation (but check the
 If you are using the command line to run your code, then you can concatenate the
 :code:`telebot` at the end of your command, like this:
 
-.. code-block:: cmd
+.. code-block:: console
 
     dir && telebot send "done!"
 
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -96,3 +96,33 @@ deployment of our app?! You can do all this with :code:`codebots`...magic! :)
 
    examples/sshbot.rst
    examples/deploybot.rst
+
+access your cloud storage
+=========================
+
+Sometimes you want to automate how you access, manipulate and edit your files in
+your cloud storage. `Drivebot` will help you with that! For now only
+Google Drive is supported, but soon more cloud providers will be supported.
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+   :glob:
+
+   examples/drivebot.rst
+
+latex made easy
+===============
+
+Latex can be intimitading at the beginning. What to install? where to find the
+right software? how to convert to different formats? I had these questions
+(I still do...) and therefore I chose to create a bot to help me (and you!).
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+   :glob:
+
+   examples/latexbot_cli.rst
+   examples/latexbot_install.rst
+   examples/latexbot_overleaf.rst
diff --git a/examples/drivebot.py b/examples/drivebot.py
@@ -0,0 +1,7 @@
+from codebots.bots import DriveBot
+
+# create a DriveBot using a web authentication and store the credentials
+dbot = DriveBot('web', True)
+
+dbot.create_and_upload(name='my_first_upload.txt',
+                       content='codebots is awesome!')
diff --git a/examples/latexbot_install.py b/examples/latexbot_install.py
@@ -0,0 +1,4 @@
+from codebots.bots import LatexBot
+
+lbot = LatexBot()
+lbot.install_dependencies(git=False, pandoc=True, miktex=True)
diff --git a/examples/latexbot_overleaf.py b/examples/latexbot_overleaf.py
@@ -0,0 +1,8 @@
+from codebots.bots import LatexBot
+
+lbot = LatexBot()
+
+# change the placeholder with your document code: you can find in the address bar
+# in your browser when you open the overleaf project.
+
+lbot.convert_overleaf_to_docx("XXXXXXXXXXXXXX", upload=True)
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -21,7 +21,7 @@ m2r
 nbsphinx
 pydocstyle
 sphinx >=3.4
-sphinx_material
+furo
 sphinx_markdown_tables
 sphinx_automodapi
 recommonmark
diff --git a/tests/test_bots.py b/tests/test_bots.py
@@ -1,12 +1,12 @@
 #!/usr/bin/env python
 
-# """Tests for `codebots` package."""
+"""Tests for `codebots` package."""
 
-# import pytest
+import pytest
 
-# from click.testing import CliRunner
+from click.testing import CliRunner
 
-# from codebots.cli import cli
+from codebots.cli import cli
 
 
 # @pytest.fixture
@@ -35,5 +35,6 @@
 #     assert help_result.exit_code == 0
 #     assert '--help  Show this message and exit.' in help_result.output
 
+
 def test_dummy():
     assert True
