Clean pyproject.toml and bump version

Signed-off-by: guillemdb <[email protected]>

.github/workflows/build.yml

@@ -11,7 +11,7 @@ on:
 env:
   PROJECT_NAME: mloq
   PROJECT_DIR: src/mloq
-  VERSION_FILE: src/mloq/version.py
+  VERSION_FILE: "src/mloq/version.py .bumpversion.cfg docs/_config.yml"
   DEFAULT_BRANCH: main
   BOT_NAME: fragile-bot
   BOT_EMAIL: [email protected]

docs/conf.py

@@ -0,0 +1,42 @@
+###############################################################################
+# Auto-generated by `jupyter-book config`
+# If you wish to continue using _config.yml, make edits to that file and
+# re-generate this one.
+###############################################################################
+author = 'Guillem Duran Ballester'
+autoapi_add_toctree_entry = True
+autoapi_dirs = ['../src']
+autodoc_typehints = 'description'
+comments_config = {'hypothesis': False, 'utterances': False}
+copyright = '2024'
+exclude_patterns = ['**.ipynb_checkpoints', '.DS_Store', 'Thumbs.db', '_build']
+extensions = ['sphinx_togglebutton', 'sphinx_copybutton', 'myst_nb', 'jupyter_book', 'sphinx_thebe', 'sphinx_comments', 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx_design', 'sphinx_book_theme', 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', 'sphinx.ext.autosectionlabel', 'sphinx.ext.autodoc.typehints', 'sphinx.ext.githubpages', 'sphinxcontrib.mermaid', 'autoapi.extension', 'sphinx_jupyterbook_latex', 'sphinx_multitoc_numbering']
+external_toc_exclude_missing = False
+external_toc_path = '_toc.yml'
+html_baseurl = ''
+html_favicon = 'favicon.png'
+html_logo = 'logo.png'
+html_sourcelink_suffix = ''
+html_theme = 'sphinx_book_theme'
+html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': '', 'jupyterhub_url': '', 'thebe': False, 'colab_url': ''}, 'path_to_docs': '', 'repository_url': 'https://github.com/FragileTech/ml-ops-quickstart', 'repository_branch': 'main', 'extra_footer': '', 'home_page_in_toc': True, 'announcement': '', 'analytics': {'google_analytics_id': ''}, 'use_repository_button': False, 'use_edit_page_button': False, 'use_issues_button': False}
+html_title = 'ML Ops Quickstart'
+imgmath_latex = '/usr/bin/latex'
+latex_engine = 'pdflatex'
+myst_enable_extensions = ['amsmath', 'colon_fence', 'deflist', 'dollarmath', 'html_admonition', 'html_image', 'linkify', 'replacements', 'smartquotes', 'substitution', 'tasklist']
+myst_url_schemes = ['mailto', 'http', 'https']
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+nb_execution_allow_errors = False
+nb_execution_cache_path = ''
+nb_execution_excludepatterns = []
+nb_execution_in_temp = False
+nb_execution_mode = 'auto'
+nb_execution_timeout = 30
+nb_output_stderr = 'show'
+numfig = True
+pygments_style = 'sphinx'
+release = '0.1.0'
+suppress_warnings = ['myst.domains']
+use_jupyterbook_latex = True
+use_multitoc_numbering = True
+version = '0.1.0'

docs/requirements.txt

@@ -1,16 +1,20 @@
 accessible-pygments==0.0.5
 alabaster==0.7.16
+arrow==1.3.0
 astroid==3.3.4
 asttokens==2.4.1
 attrs==24.2.0
 autoapi==2.0.1
 babel==2.16.0
 beautifulsoup4==4.12.3
+binaryornot==0.4.4
 certifi==2024.8.30
 cfgv==3.4.0
+chardet==5.2.0
 charset-normalizer==3.3.2
 click==8.1.7
 comm==0.2.2
+cookiecutter==2.6.0
 debugpy==1.8.6
 decorator==5.1.1
 distlib==0.3.8
@@ -30,6 +34,7 @@ ipykernel==6.29.5
 ipython==8.27.0
 jedi==0.19.1
 jinja2==3.1.4
+jinja2-time==0.2.0
 jsonschema==4.23.0
 jsonschema-specifications==2023.12.1
 jupyter-book==1.0.2
@@ -64,10 +69,12 @@ pybtex-docutils==1.0.3
 pydata-sphinx-theme==0.15.4
 pygments==2.18.0
 python-dateutil==2.9.0.post0
+python-slugify==8.0.4
 pyyaml==6.0.2
 pyzmq==26.2.0
 referencing==0.35.1
 requests==2.32.3
+rich==13.9.2
 rpds-py==0.20.0
 ruyaml==0.91.0
 setuptools==75.1.0
@@ -100,9 +107,11 @@ sphinxext-opengraph==0.9.1
 sqlalchemy==2.0.35
 stack-data==0.6.3
 tabulate==0.9.0
+text-unidecode==1.3
 tomli==2.0.2
 tornado==6.4.1
 traitlets==5.14.3
+types-python-dateutil==2.9.0.20241003
 typing-extensions==4.12.2
 uc-micro-py==1.0.3
 urllib3==2.2.3

docs/source/project/AUTHORS.md

@@ -0,0 +1,3 @@
+# Authors
+
+* Guillem Duran Ballester - fragile.tech

docs/source/project/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+
+0.1.0 (2024-10-06)
+------------------
+
+* First release on PyPI.

docs/source/project/CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+```{contents}
+```
+
+## Bug reports
+
+When [reporting a bug](https://github.com/FragileTech/ml-ops-quickstart/issues) please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+## Documentation improvements
+
+ML Ops Quickstart could always use more documentation, whether as part of the official ML Ops Quickstart docs, in docstrings, or even on the web in blog posts, articles, and such.
+
+## Feature requests and feedback
+
+The best way to send feedback is to file an issue at [https://github.com/FragileTech/ml-ops-quickstart/issues](https://github.com/FragileTech/ml-ops-quickstart/issues).
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
+
+## Development
+
+To set up `ml-ops-quickstart` for local development:
+
+1. Fork [ml-ops-quickstart](https://github.com/FragileTech/ml-ops-quickstart) (look for the "Fork" button).
+2. Clone your fork locally:
+
+    ```bash
+    git clone [email protected]:YOURGITHUBNAME/ml-ops-quickstart.git
+    ```
+
+3. Create a branch for local development:
+
+    ```bash
+    git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+   Now you can make your changes locally.
+
+4. When you're done making changes run all the checks and docs builder with one command:
+
+    ```bash
+    rye run all
+    ```
+
+5. Commit your changes and push your branch to GitHub:
+
+    ```bash
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+    ```
+
+6. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+If you need some code review or feedback while you're developing the code just make the pull request.
+
+For merging, you should:
+
+1. Include passing tests (run `hatch test`).
+2. Update documentation when there's new API, functionality etc.
+3. Add a note to `CHANGELOG.md` about the changes.
+4. Add yourself to `AUTHORS.md`.
+