Merge pull request #56 from andr3slelouch/desarrollo-andr3slelouch

Desarrollo andr3slelouch
andr3slelouch · Feb 17, 2021 · ed4b7a8 · ed4b7a8
2 parents 7e8d003 + 66f8aad
commit ed4b7a8
Show file tree

Hide file tree

Showing 60 changed files with 25,416 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 Los estudiantes de la Escuela Politécnica Nacional(EPN) utilizan una versión de moodle para la administración de tareas, exámenes, etc de ciertas materias en cada semestre.
 El fin de PoliCal es poder sincronizar desde el calendario electrónico que ofrece el aula virtual hacia Trello que es una plataforma muy poderosa para organizar tareas y proyectos.
+Actualmente se ha implementado un bot en Telegram, para poder administrar las tareas desde dicha plataforma de mensajería y puede ser utilizado buscando al usuario https://telegram.me/polical_bot
 ## Para Linux
 ### Instalar desde Pypi
 
@@ -49,6 +50,31 @@ Caso contrario:
 py -m polical
 ```
 
+## Opciones disponibles en Línea de Comandos
+
+```
+[andr3slelouch]$ polical -h
+usage: cli.py [-h] [--add_user] [--todo] [--bot] [--load_subjects_from_csv] [--update_subjects_from_csv] [--show_directory]
+              [--set_telegram_token SET_TELEGRAM_TOKEN]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --add_user, -au       Add a new user with interactive cli
+  --todo, -t            Look for tasks adn write to todo.txt and done.txt
+  --bot, -b             Executes the bot for telegram it requires a mysql database executing and a token for Telegram Bot
+  --load_subjects_from_csv, -lcsv
+                        Load new subjects to the sqlite3 database from materias.csv located in working directory
+  --update_subjects_from_csv, -ucsv
+                        Updates subjects to the sqlite3 database from materias.csv located in working directory
+  --show_directory, -sd
+                        Prints the working directory address where the config files are saved
+  --set_telegram_token SET_TELEGRAM_TOKEN, -tk SET_TELEGRAM_TOKEN
+                        Save the telegram token to config.yaml configuration file
+```
+
+## Documentación
+Todo el código seencuentra documentado con docstrings y un resumen general puede ser encontrado en [readthedocs](https://polical.readthedocs.io/)
+
 ### NOTAS
 Actualmente se encuentran precargadas todas las materias obtenidas desde el SAEW de las siguientes carreras:
 - Ingeniería en Sistemas Informáticos y de Computación PENSUM: 2009B
@@ -63,4 +89,4 @@ Si deseas usar el programa y tu carrera no se encuentra registrada, siéntete li
 
 Lo puedes obtener desde esta página iniciando previamente sesión en el SAEW https://saew.epn.edu.ec/SAEINF/HorariosMaterias.aspx
 
-PoliCal no se encuentra asociado de ninguna forma con Trello.
+PoliCal no se encuentra asociado de ninguna forma con Trello, Telegram, o la Ecuela Politécnica Nacional.
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ceb364250f25929ee7916b2ff55ba244
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/.nojekyll b/docs/html/.nojekyll
diff --git a/docs/html/_modules/index.html b/docs/html/_modules/index.html
@@ -0,0 +1,207 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+
+  <title>Overview: module code &mdash; PoliCal 1.1.3 documentation</title>
+
+
+
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+
+
+
+
+
+
+
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="../index.html" class="icon icon-home"> PoliCal
+
+
+
+          </a>
+
+
+
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <!-- Local TOC -->
+              <div class="local-toc"></div>
+
+
+        </div>
+
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">PoliCal</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
+
+      <li>Overview: module code</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="polical/Get_Trello_MoodleEPN_Keys.html">polical.Get_Trello_MoodleEPN_Keys</a></li>
+<li><a href="polical/MateriaClass.html">polical.MateriaClass</a></li>
+<li><a href="polical/MateriasLoaderToDB.html">polical.MateriasLoaderToDB</a></li>
+<li><a href="polical/SendTaskToTrello.html">polical.SendTaskToTrello</a></li>
+<li><a href="polical/SimpleIcsToCSV.html">polical.SimpleIcsToCSV</a></li>
+<li><a href="polical/TareaClass.html">polical.TareaClass</a></li>
+<li><a href="polical/TareasCSVToBD.html">polical.TareasCSVToBD</a></li>
+<li><a href="polical/__main__.html">polical.__main__</a></li>
+<li><a href="polical/bot/policalbot.html">polical.bot.policalbot</a></li>
+<li><a href="polical/configuration.html">polical.configuration</a></li>
+<li><a href="polical/connectSQLite.html">polical.connectSQLite</a></li>
+<li><a href="polical/tasks_processor.html">polical.tasks_processor</a></li>
+<li><a href="polical/todo_generator.html">polical.todo_generator</a></li>
+</ul>
+
+           </div>
+
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &#169; Copyright 2021, andr3slelouch.
+
+    </p>
+  </div>
+
+
+
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+
+    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>