From dc0a1e3afc56bc09cc149fc99227805b5ef66665 Mon Sep 17 00:00:00 2001 From: xmnlab Date: Thu, 17 Oct 2024 03:58:04 +0000 Subject: [PATCH] deploy: 059de08b3abb5061f833c964525bf2b1e0138947 --- changelog/index.html | 141 ++++++++++++++++++++++++++++++++------- search/search_index.json | 2 +- 2 files changed, 117 insertions(+), 26 deletions(-) diff --git a/changelog/index.html b/changelog/index.html index 06fdef8..3ca18be 100644 --- a/changelog/index.html +++ b/changelog/index.html @@ -281,6 +281,17 @@ + + @@ -291,6 +302,49 @@ + + + + @@ -335,6 +389,38 @@ + + + @@ -353,6 +439,11 @@

Release Notes

+

1.16.1 (2024-10-17)

+

Bug Fixes

+

1.16.0 (2024-10-17)

Features

1.14.2 (2024-10-15)

-

Bug Fixes

+

Bug Fixes

1.14.1 (2024-09-27)

-

Bug Fixes

+

Bug Fixes

@@ -386,7 +477,7 @@

Features

  • experimental: Add new docker compose commands: attach, cp, ls, scale, wait, watch (#122) (4a28eee)

    • 1.12.0 (2024-05-10)

    -

    Bug Fixes

    +

    Bug Fixes

    @@ -395,23 +486,23 @@

    Features

  • Implement typer as CLI (#117) (b9def08)

    • 1.11.4 (2024-05-07)

    -

    Bug Fixes

    +

    Bug Fixes

    1.11.3 (2024-05-07)

    -

    Bug Fixes

    +

    Bug Fixes

    1.11.2 (2024-03-15)

    -

    Bug Fixes

    +

    Bug Fixes

    1.11.1 (2024-02-04)

    -

    Bug Fixes

    +

    Bug Fixes

    @@ -421,7 +512,7 @@

    Features

  • Add stats plot command (#113) (15d92cc)

    • 1.10.0 (2024-01-25)

    -

    Bug Fixes

    +

    Bug Fixes

    1.9.3 (2023-12-24)

    -

    Bug Fixes

    +

    Bug Fixes

    1.9.2 (2023-12-13)

    -

    Bug Fixes

    +

    Bug Fixes

    1.9.1 (2023-11-15)

    -

    Bug Fixes

    +

    Bug Fixes

    @@ -458,7 +549,7 @@

    Features

  • Add default config for project-name (#82) (1dab380)

    • 1.7.1 (2023-06-15)

    -

    Bug Fixes

    +

    Bug Fixes

    @@ -468,7 +559,7 @@

    Features

  • Add support for default option configuration for group service (#80) (0045a4a)

    • 1.6.1 (2023-06-05)

    -

    Bug Fixes

    +

    Bug Fixes

    @@ -484,22 +575,22 @@

    Features

  • Improve the usage of parameters --cmd and --options (formerly --extras) (#68) (cebdfd8)

    • 1.4.4 (2023-04-05)

    -

    Bug Fixes

    +

    Bug Fixes

    1.4.3 (2023-03-25)

    -

    Bug Fixes

    +

    Bug Fixes

    1.4.2 (2023-03-08)

    -

    Bug Fixes

    +

    Bug Fixes

    1.4.1 (2023-02-15)

    -

    Bug Fixes

    +

    Bug Fixes

    @@ -509,12 +600,12 @@

    Features

  • Add support for multiples compose-path (#37) (c726250)

    • 1.3.2 (2023-02-09)

    -

    Bug Fixes

    +

    Bug Fixes

    1.3.1 (2023-02-07)

    -

    Bug Fixes

    +

    Bug Fixes

    @@ -534,32 +625,32 @@

    Features

  • Add run and exec initial implementation (#21) (332f2bc)

    • 1.0.6 (2023-01-27)

    -

    Bug Fixes

    +

    Bug Fixes

    1.0.5 (2023-01-26)

    -

    Bug Fixes

    +

    Bug Fixes

    1.0.4 (2023-01-26)

    -

    Bug Fixes

    +

    Bug Fixes

    1.0.3 (2023-01-26)

    -

    Bug Fixes

    +

    Bug Fixes

    1.0.2 (2023-01-26)

    -

    Bug Fixes

    +

    Bug Fixes

    1.0.1 (2023-01-21)

    -

    Bug Fixes

    +

    Bug Fixes

    diff --git a/search/search_index.json b/search/search_index.json index a399dcb..5107e71 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Macro Rendering Error","text":"

    UndefinedError: 'env' is undefined

    Traceback (most recent call last):\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/mkdocs_macros/plugin.py\", line 480, in render\n    return md_template.render(**page_variables)\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/jinja2/environment.py\", line 1304, in render\n    self.environment.handle_exception()\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/jinja2/environment.py\", line 939, in handle_exception\n    raise rewrite_traceback_stack(source=source)\n  File \"<template>\", line 125, in top-level template code\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/jinja2/environment.py\", line 487, in getattr\n    return getattr(obj, attribute)\njinja2.exceptions.UndefinedError: 'env' is undefined\n
    "},{"location":"changelog/","title":"Release Notes","text":""},{"location":"changelog/#1160-2024-10-17","title":"1.16.0 (2024-10-17)","text":""},{"location":"changelog/#features","title":"Features","text":""},{"location":"changelog/#1150-2024-10-16","title":"1.15.0 (2024-10-16)","text":""},{"location":"changelog/#features_1","title":"Features","text":""},{"location":"changelog/#1142-2024-10-15","title":"1.14.2 (2024-10-15)","text":""},{"location":"changelog/#bug-fixes","title":"Bug Fixes","text":""},{"location":"changelog/#1141-2024-09-27","title":"1.14.1 (2024-09-27)","text":""},{"location":"changelog/#bug-fixes_1","title":"Bug Fixes","text":""},{"location":"changelog/#1140-2024-07-24","title":"1.14.0 (2024-07-24)","text":""},{"location":"changelog/#features_2","title":"Features","text":""},{"location":"changelog/#1130-2024-05-16","title":"1.13.0 (2024-05-16)","text":""},{"location":"changelog/#features_3","title":"Features","text":""},{"location":"changelog/#1120-2024-05-10","title":"1.12.0 (2024-05-10)","text":""},{"location":"changelog/#bug-fixes_2","title":"Bug Fixes","text":""},{"location":"changelog/#features_4","title":"Features","text":""},{"location":"changelog/#1114-2024-05-07","title":"1.11.4 (2024-05-07)","text":""},{"location":"changelog/#bug-fixes_3","title":"Bug Fixes","text":""},{"location":"changelog/#1113-2024-05-07","title":"1.11.3 (2024-05-07)","text":""},{"location":"changelog/#bug-fixes_4","title":"Bug Fixes","text":""},{"location":"changelog/#1112-2024-03-15","title":"1.11.2 (2024-03-15)","text":""},{"location":"changelog/#bug-fixes_5","title":"Bug Fixes","text":""},{"location":"changelog/#1111-2024-02-04","title":"1.11.1 (2024-02-04)","text":""},{"location":"changelog/#bug-fixes_6","title":"Bug Fixes","text":""},{"location":"changelog/#1110-2024-02-04","title":"1.11.0 (2024-02-04)","text":""},{"location":"changelog/#features_5","title":"Features","text":""},{"location":"changelog/#1100-2024-01-25","title":"1.10.0 (2024-01-25)","text":""},{"location":"changelog/#bug-fixes_7","title":"Bug Fixes","text":""},{"location":"changelog/#features_6","title":"Features","text":""},{"location":"changelog/#193-2023-12-24","title":"1.9.3 (2023-12-24)","text":""},{"location":"changelog/#bug-fixes_8","title":"Bug Fixes","text":""},{"location":"changelog/#192-2023-12-13","title":"1.9.2 (2023-12-13)","text":""},{"location":"changelog/#bug-fixes_9","title":"Bug Fixes","text":""},{"location":"changelog/#191-2023-11-15","title":"1.9.1 (2023-11-15)","text":""},{"location":"changelog/#bug-fixes_10","title":"Bug Fixes","text":""},{"location":"changelog/#190-2023-07-19","title":"1.9.0 (2023-07-19)","text":""},{"location":"changelog/#features_7","title":"Features","text":""},{"location":"changelog/#180-2023-07-17","title":"1.8.0 (2023-07-17)","text":""},{"location":"changelog/#features_8","title":"Features","text":""},{"location":"changelog/#171-2023-06-15","title":"1.7.1 (2023-06-15)","text":""},{"location":"changelog/#bug-fixes_11","title":"Bug Fixes","text":""},{"location":"changelog/#170-2023-06-06","title":"1.7.0 (2023-06-06)","text":""},{"location":"changelog/#features_9","title":"Features","text":""},{"location":"changelog/#161-2023-06-05","title":"1.6.1 (2023-06-05)","text":""},{"location":"changelog/#bug-fixes_12","title":"Bug Fixes","text":""},{"location":"changelog/#160-2023-05-27","title":"1.6.0 (2023-05-27)","text":""},{"location":"changelog/#features_10","title":"Features","text":""},{"location":"changelog/#150-2023-04-07","title":"1.5.0 (2023-04-07)","text":""},{"location":"changelog/#features_11","title":"Features","text":""},{"location":"changelog/#144-2023-04-05","title":"1.4.4 (2023-04-05)","text":""},{"location":"changelog/#bug-fixes_13","title":"Bug Fixes","text":""},{"location":"changelog/#143-2023-03-25","title":"1.4.3 (2023-03-25)","text":""},{"location":"changelog/#bug-fixes_14","title":"Bug Fixes","text":""},{"location":"changelog/#142-2023-03-08","title":"1.4.2 (2023-03-08)","text":""},{"location":"changelog/#bug-fixes_15","title":"Bug Fixes","text":""},{"location":"changelog/#141-2023-02-15","title":"1.4.1 (2023-02-15)","text":""},{"location":"changelog/#bug-fixes_16","title":"Bug Fixes","text":""},{"location":"changelog/#140-2023-02-09","title":"1.4.0 (2023-02-09)","text":""},{"location":"changelog/#features_12","title":"Features","text":""},{"location":"changelog/#132-2023-02-09","title":"1.3.2 (2023-02-09)","text":""},{"location":"changelog/#bug-fixes_17","title":"Bug Fixes","text":""},{"location":"changelog/#131-2023-02-07","title":"1.3.1 (2023-02-07)","text":""},{"location":"changelog/#bug-fixes_18","title":"Bug Fixes","text":""},{"location":"changelog/#130-2023-02-07","title":"1.3.0 (2023-02-07)","text":""},{"location":"changelog/#features_13","title":"Features","text":""},{"location":"changelog/#120-2023-02-06","title":"1.2.0 (2023-02-06)","text":""},{"location":"changelog/#features_14","title":"Features","text":""},{"location":"changelog/#110-2023-01-27","title":"1.1.0 (2023-01-27)","text":""},{"location":"changelog/#features_15","title":"Features","text":""},{"location":"changelog/#106-2023-01-27","title":"1.0.6 (2023-01-27)","text":""},{"location":"changelog/#bug-fixes_19","title":"Bug Fixes","text":""},{"location":"changelog/#105-2023-01-26","title":"1.0.5 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_20","title":"Bug Fixes","text":""},{"location":"changelog/#104-2023-01-26","title":"1.0.4 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_21","title":"Bug Fixes","text":""},{"location":"changelog/#103-2023-01-26","title":"1.0.3 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_22","title":"Bug Fixes","text":""},{"location":"changelog/#102-2023-01-26","title":"1.0.2 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_23","title":"Bug Fixes","text":""},{"location":"changelog/#101-2023-01-21","title":"1.0.1 (2023-01-21)","text":""},{"location":"changelog/#bug-fixes_24","title":"Bug Fixes","text":""},{"location":"contributing/","title":"Contributing","text":"

    Your contributions are valued and play a significant role in the continuous improvement of Sugar. We welcome contributions of all forms and acknowledge all efforts.

    "},{"location":"contributing/#how-you-can-contribute","title":"How You Can Contribute","text":"

    Contributions can be made in various ways, outlined below:

    "},{"location":"contributing/#report-bugs","title":"Report Bugs","text":"

    If you encounter a bug in Sugar, please report it via our GitHub issues page at: https://github.com/osl-incubator/sugar/issues.

    When reporting a bug, kindly include the following information to aid in the issue's resolution:

    "},{"location":"contributing/#fix-bugs","title":"Fix Bugs","text":"

    You can contribute by fixing bugs identified in the GitHub issues. Issues tagged with both \"bug\" and \"help wanted\" are available for anyone to work on.

    "},{"location":"contributing/#implement-features","title":"Implement Features","text":"

    Feature development is another way to contribute. Review the GitHub issues for requested features. Issues labeled with \"enhancement\" and \"help wanted\" are open for implementation.

    "},{"location":"contributing/#write-documentation","title":"Write Documentation","text":"

    There's always a need for more documentation for Sugar. This could be through enhancing the official documentation, contributing to docstrings, or sharing knowledge via blog posts, articles, and other media.

    "},{"location":"contributing/#submit-feedback","title":"Submit Feedback","text":"

    Feedback is crucial for project improvement. To submit feedback or propose a feature:

    "},{"location":"contributing/#requirements","title":"Requirements","text":"

    Before you begin contributing to the Sugar project, there are several technical prerequisites and best practices you should be familiar with. This section outlines the key requirements to ensure a smooth and productive contribution process.

    "},{"location":"contributing/#conda-environment","title":"Conda Environment","text":"

    Conda is a versatile tool that provides package, dependency, and environment management for various programming languages. In the Sugar project, we leverage Conda to manage virtual environments and package dependencies effectively.

    "},{"location":"contributing/#git","title":"Git","text":"

    Our collaborative efforts are facilitated through Git and GitHub. Understanding the fundamentals of Git is crucial for effective participation.

    "},{"location":"contributing/#python","title":"Python","text":"

    Familiarity with Python and adherence to best practices is important for contributing to Sugar.

    "},{"location":"contributing/#docker","title":"Docker","text":"

    Docker and Docker Compose are fundamental components within the sugar project infrastructure. These technologies facilitate the creation, deployment, and management of isolated environments, making them integral to development and testing processes in sugar.

    To gain a foundational understanding of Docker and Docker Compose, consider exploring the following tutorial, which provides a comprehensive introduction to both technologies: Educative: Docker Compose Tutorial. This resource is designed to help newcomers grasp the essentials of Docker and Docker Compose, covering everything from basic concepts to advanced usage scenarios.

    A thorough comprehension of Docker and Docker Compose is crucial for contributing to the sugar project, as all development and deployment workflows are designed around these technologies.

    "},{"location":"contributing/#how-to-get-support","title":"How to Get Support","text":"

    Should you require assistance, please join our community on the Open Science Labs Discord server at https://opensciencelabs.org/discord. Here, you can participate in the incubator program and ask questions about Sugar in its dedicated channel. You are also welcome to explore and join other groups that align with your interests.

    "},{"location":"contributing/#setting-up-for-local-development","title":"Setting Up for Local Development","text":"

    To contribute to sugar, follow these steps to set up your development environment:

    1. Fork the Repository: Begin by forking the sugar repository on GitHub to your own account.

    2. Clone Your Fork Locally: Clone the forked repository to your local machine and navigate into the project directory.

    $ git clone git@github.com:your_username/sugar.git\n$ cd sugar\n
    1. Install Dependencies: Use mamba to create a Conda environment and poetry for managing Python dependencies.
    $ mamba env create --file conda/dev.yaml --force\n$ poetry config virtualenvs.create false\n$ poetry install\n
    1. Create a Development Branch: Make a dedicated branch for your bugfix or feature.
    $ git checkout -b name-of-your-bugfix-or-feature\n

    1. Make Changes Locally: You are now ready to implement your changes or improvements.

    2. Install and Use Pre-commit Hooks: sugar utilizes pre-commit hooks to ensure code quality. Install them locally and they will automatically run on each commit.

    $ pre-commit install\n$ pre-commit run --all-files\n

    To bypass the hooks temporarily, use git commit with --no-verify.

    1. Run Smoke Tests: Quickly validate the functionality of your changes with smoke tests.
    $ makim tests.smoke\n

    Always complement smoke tests with thorough unit testing to ensure code integrity.

    1. Unit Testing with pytest: sugar leverages pytest for unit testing, along with pytest-cov for coverage analysis. Run unit tests using:
    $ python -m pytest\n

    or

    $ makim tests.unittest\n
    1. Commit and Push Changes: Stage, commit, and push your changes to GitHub. After setting the upstream branch once, subsequent pushes only require git push.
    $ git add .\n$ git commit -m \"Detailed description of your changes.\"\n$ git push --set-upstream origin <branch name>\n
    1. Submit a Pull Request: Once your changes are pushed, go to the GitHub website to submit a pull request for review.
    "},{"location":"contributing/#release-process","title":"Release Process","text":"

    The Sugar project utilizes semantic-release to automate the release process, basing new releases on the content of commit messages.

    "},{"location":"contributing/#commit-message-format","title":"Commit Message Format","text":"

    semantic-release analyzes commit messages to assess the impact of changes made to the codebase. Adhering to a standardized commit message format allows semantic-release to automatically determine the next semantic version number, generate a comprehensive changelog, and publish the release.

    While semantic-release defaults to the Angular Commit Message Conventions, Sugar adopts the \"Conventional Commits\" standard (https://www.conventionalcommits.org/en/v1.0.0/). This standard facilitates more detailed commit messages, especially for \"breaking changes\".

    Given the project's use of the squash and merge strategy for merging pull requests, it is crucial to format the PR title according to the commit message standards.

    To aid contributors in crafting compliant commit messages, tools like commitizen and commitlint are recommended. These tools help ensure that commit messages adhere to the required format.

    The following table illustrates how different commit messages correspond to the type of release generated by semantic-release, according to its default configuration:

    Commit Message Example Release Type fix(pencil): stop graphite breaking when too much pressure Patch Release feat(pencil): add 'graphiteWidth' option Minor Release perf(pencil): optimize 'graphiteWidth' calculation Patch Release fix(pencil)!: 'graphiteWidth' option removed Major Release

    Note: Within the Conventional Commits standard, appending ! to the message prefix indicates a breaking change.

    For more details on the commit message format used by semantic-release, visit the semantic-release documentation.

    "},{"location":"example/","title":"sugar","text":"In\u00a0[\u00a0]: Copied! 
    import sugar\n
    import sugar"},{"location":"example/#sugar","title":"sugar\u00b6","text":"

    sugar is Python library that aims to do ...

    "},{"location":"example/#getting-started","title":"Getting Started\u00b6","text":"

    First, check our documentation about the installation.

    Now, let's import our library:

    "},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#stable-release","title":"Stable release","text":"

    To install sugar, run this command in your terminal:

    $ pip install containers-sugar\n

    Sugar is also available on conda-forge

    $ conda install -c conda-forge containers-sugar\n

    This is the preferred method to install sugar, as it will always install the most recent stable release.

    "},{"location":"installation/#from-sources","title":"From sources","text":"

    The sources for sugar can be downloaded from the Github repo.

    You can either clone the public repository:

    $ git clone https://github.com/osl-incubator/sugar.git\n

    Or download the tarball:

    $ curl -OJL https://github.com/osl-incubator/sugar.git/tarball/main\n

    Once you have a copy of the source, you can install it with:

    $ poetry install\n
    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Macro Rendering Error","text":"

    UndefinedError: 'env' is undefined

    Traceback (most recent call last):\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/mkdocs_macros/plugin.py\", line 480, in render\n    return md_template.render(**page_variables)\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/jinja2/environment.py\", line 1304, in render\n    self.environment.handle_exception()\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/jinja2/environment.py\", line 939, in handle_exception\n    raise rewrite_traceback_stack(source=source)\n  File \"<template>\", line 125, in top-level template code\n  File \"/home/runner/miniconda3/envs/sugar/lib/python3.10/site-packages/jinja2/environment.py\", line 487, in getattr\n    return getattr(obj, attribute)\njinja2.exceptions.UndefinedError: 'env' is undefined\n
    "},{"location":"changelog/","title":"Release Notes","text":""},{"location":"changelog/#1161-2024-10-17","title":"1.16.1 (2024-10-17)","text":""},{"location":"changelog/#bug-fixes","title":"Bug Fixes","text":""},{"location":"changelog/#1160-2024-10-17","title":"1.16.0 (2024-10-17)","text":""},{"location":"changelog/#features","title":"Features","text":""},{"location":"changelog/#1150-2024-10-16","title":"1.15.0 (2024-10-16)","text":""},{"location":"changelog/#features_1","title":"Features","text":""},{"location":"changelog/#1142-2024-10-15","title":"1.14.2 (2024-10-15)","text":""},{"location":"changelog/#bug-fixes_1","title":"Bug Fixes","text":""},{"location":"changelog/#1141-2024-09-27","title":"1.14.1 (2024-09-27)","text":""},{"location":"changelog/#bug-fixes_2","title":"Bug Fixes","text":""},{"location":"changelog/#1140-2024-07-24","title":"1.14.0 (2024-07-24)","text":""},{"location":"changelog/#features_2","title":"Features","text":""},{"location":"changelog/#1130-2024-05-16","title":"1.13.0 (2024-05-16)","text":""},{"location":"changelog/#features_3","title":"Features","text":""},{"location":"changelog/#1120-2024-05-10","title":"1.12.0 (2024-05-10)","text":""},{"location":"changelog/#bug-fixes_3","title":"Bug Fixes","text":""},{"location":"changelog/#features_4","title":"Features","text":""},{"location":"changelog/#1114-2024-05-07","title":"1.11.4 (2024-05-07)","text":""},{"location":"changelog/#bug-fixes_4","title":"Bug Fixes","text":""},{"location":"changelog/#1113-2024-05-07","title":"1.11.3 (2024-05-07)","text":""},{"location":"changelog/#bug-fixes_5","title":"Bug Fixes","text":""},{"location":"changelog/#1112-2024-03-15","title":"1.11.2 (2024-03-15)","text":""},{"location":"changelog/#bug-fixes_6","title":"Bug Fixes","text":""},{"location":"changelog/#1111-2024-02-04","title":"1.11.1 (2024-02-04)","text":""},{"location":"changelog/#bug-fixes_7","title":"Bug Fixes","text":""},{"location":"changelog/#1110-2024-02-04","title":"1.11.0 (2024-02-04)","text":""},{"location":"changelog/#features_5","title":"Features","text":""},{"location":"changelog/#1100-2024-01-25","title":"1.10.0 (2024-01-25)","text":""},{"location":"changelog/#bug-fixes_8","title":"Bug Fixes","text":""},{"location":"changelog/#features_6","title":"Features","text":""},{"location":"changelog/#193-2023-12-24","title":"1.9.3 (2023-12-24)","text":""},{"location":"changelog/#bug-fixes_9","title":"Bug Fixes","text":""},{"location":"changelog/#192-2023-12-13","title":"1.9.2 (2023-12-13)","text":""},{"location":"changelog/#bug-fixes_10","title":"Bug Fixes","text":""},{"location":"changelog/#191-2023-11-15","title":"1.9.1 (2023-11-15)","text":""},{"location":"changelog/#bug-fixes_11","title":"Bug Fixes","text":""},{"location":"changelog/#190-2023-07-19","title":"1.9.0 (2023-07-19)","text":""},{"location":"changelog/#features_7","title":"Features","text":""},{"location":"changelog/#180-2023-07-17","title":"1.8.0 (2023-07-17)","text":""},{"location":"changelog/#features_8","title":"Features","text":""},{"location":"changelog/#171-2023-06-15","title":"1.7.1 (2023-06-15)","text":""},{"location":"changelog/#bug-fixes_12","title":"Bug Fixes","text":""},{"location":"changelog/#170-2023-06-06","title":"1.7.0 (2023-06-06)","text":""},{"location":"changelog/#features_9","title":"Features","text":""},{"location":"changelog/#161-2023-06-05","title":"1.6.1 (2023-06-05)","text":""},{"location":"changelog/#bug-fixes_13","title":"Bug Fixes","text":""},{"location":"changelog/#160-2023-05-27","title":"1.6.0 (2023-05-27)","text":""},{"location":"changelog/#features_10","title":"Features","text":""},{"location":"changelog/#150-2023-04-07","title":"1.5.0 (2023-04-07)","text":""},{"location":"changelog/#features_11","title":"Features","text":""},{"location":"changelog/#144-2023-04-05","title":"1.4.4 (2023-04-05)","text":""},{"location":"changelog/#bug-fixes_14","title":"Bug Fixes","text":""},{"location":"changelog/#143-2023-03-25","title":"1.4.3 (2023-03-25)","text":""},{"location":"changelog/#bug-fixes_15","title":"Bug Fixes","text":""},{"location":"changelog/#142-2023-03-08","title":"1.4.2 (2023-03-08)","text":""},{"location":"changelog/#bug-fixes_16","title":"Bug Fixes","text":""},{"location":"changelog/#141-2023-02-15","title":"1.4.1 (2023-02-15)","text":""},{"location":"changelog/#bug-fixes_17","title":"Bug Fixes","text":""},{"location":"changelog/#140-2023-02-09","title":"1.4.0 (2023-02-09)","text":""},{"location":"changelog/#features_12","title":"Features","text":""},{"location":"changelog/#132-2023-02-09","title":"1.3.2 (2023-02-09)","text":""},{"location":"changelog/#bug-fixes_18","title":"Bug Fixes","text":""},{"location":"changelog/#131-2023-02-07","title":"1.3.1 (2023-02-07)","text":""},{"location":"changelog/#bug-fixes_19","title":"Bug Fixes","text":""},{"location":"changelog/#130-2023-02-07","title":"1.3.0 (2023-02-07)","text":""},{"location":"changelog/#features_13","title":"Features","text":""},{"location":"changelog/#120-2023-02-06","title":"1.2.0 (2023-02-06)","text":""},{"location":"changelog/#features_14","title":"Features","text":""},{"location":"changelog/#110-2023-01-27","title":"1.1.0 (2023-01-27)","text":""},{"location":"changelog/#features_15","title":"Features","text":""},{"location":"changelog/#106-2023-01-27","title":"1.0.6 (2023-01-27)","text":""},{"location":"changelog/#bug-fixes_20","title":"Bug Fixes","text":""},{"location":"changelog/#105-2023-01-26","title":"1.0.5 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_21","title":"Bug Fixes","text":""},{"location":"changelog/#104-2023-01-26","title":"1.0.4 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_22","title":"Bug Fixes","text":""},{"location":"changelog/#103-2023-01-26","title":"1.0.3 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_23","title":"Bug Fixes","text":""},{"location":"changelog/#102-2023-01-26","title":"1.0.2 (2023-01-26)","text":""},{"location":"changelog/#bug-fixes_24","title":"Bug Fixes","text":""},{"location":"changelog/#101-2023-01-21","title":"1.0.1 (2023-01-21)","text":""},{"location":"changelog/#bug-fixes_25","title":"Bug Fixes","text":""},{"location":"contributing/","title":"Contributing","text":"

    Your contributions are valued and play a significant role in the continuous improvement of Sugar. We welcome contributions of all forms and acknowledge all efforts.

    "},{"location":"contributing/#how-you-can-contribute","title":"How You Can Contribute","text":"

    Contributions can be made in various ways, outlined below:

    "},{"location":"contributing/#report-bugs","title":"Report Bugs","text":"

    If you encounter a bug in Sugar, please report it via our GitHub issues page at: https://github.com/osl-incubator/sugar/issues.

    When reporting a bug, kindly include the following information to aid in the issue's resolution:

    "},{"location":"contributing/#fix-bugs","title":"Fix Bugs","text":"

    You can contribute by fixing bugs identified in the GitHub issues. Issues tagged with both \"bug\" and \"help wanted\" are available for anyone to work on.

    "},{"location":"contributing/#implement-features","title":"Implement Features","text":"

    Feature development is another way to contribute. Review the GitHub issues for requested features. Issues labeled with \"enhancement\" and \"help wanted\" are open for implementation.

    "},{"location":"contributing/#write-documentation","title":"Write Documentation","text":"

    There's always a need for more documentation for Sugar. This could be through enhancing the official documentation, contributing to docstrings, or sharing knowledge via blog posts, articles, and other media.

    "},{"location":"contributing/#submit-feedback","title":"Submit Feedback","text":"

    Feedback is crucial for project improvement. To submit feedback or propose a feature:

    "},{"location":"contributing/#requirements","title":"Requirements","text":"

    Before you begin contributing to the Sugar project, there are several technical prerequisites and best practices you should be familiar with. This section outlines the key requirements to ensure a smooth and productive contribution process.

    "},{"location":"contributing/#conda-environment","title":"Conda Environment","text":"

    Conda is a versatile tool that provides package, dependency, and environment management for various programming languages. In the Sugar project, we leverage Conda to manage virtual environments and package dependencies effectively.

    "},{"location":"contributing/#git","title":"Git","text":"

    Our collaborative efforts are facilitated through Git and GitHub. Understanding the fundamentals of Git is crucial for effective participation.

    "},{"location":"contributing/#python","title":"Python","text":"

    Familiarity with Python and adherence to best practices is important for contributing to Sugar.

    "},{"location":"contributing/#docker","title":"Docker","text":"

    Docker and Docker Compose are fundamental components within the sugar project infrastructure. These technologies facilitate the creation, deployment, and management of isolated environments, making them integral to development and testing processes in sugar.

    To gain a foundational understanding of Docker and Docker Compose, consider exploring the following tutorial, which provides a comprehensive introduction to both technologies: Educative: Docker Compose Tutorial. This resource is designed to help newcomers grasp the essentials of Docker and Docker Compose, covering everything from basic concepts to advanced usage scenarios.

    A thorough comprehension of Docker and Docker Compose is crucial for contributing to the sugar project, as all development and deployment workflows are designed around these technologies.

    "},{"location":"contributing/#how-to-get-support","title":"How to Get Support","text":"

    Should you require assistance, please join our community on the Open Science Labs Discord server at https://opensciencelabs.org/discord. Here, you can participate in the incubator program and ask questions about Sugar in its dedicated channel. You are also welcome to explore and join other groups that align with your interests.

    "},{"location":"contributing/#setting-up-for-local-development","title":"Setting Up for Local Development","text":"

    To contribute to sugar, follow these steps to set up your development environment:

    1. Fork the Repository: Begin by forking the sugar repository on GitHub to your own account.

    2. Clone Your Fork Locally: Clone the forked repository to your local machine and navigate into the project directory.

    $ git clone git@github.com:your_username/sugar.git\n$ cd sugar\n
    1. Install Dependencies: Use mamba to create a Conda environment and poetry for managing Python dependencies.
    $ mamba env create --file conda/dev.yaml --force\n$ poetry config virtualenvs.create false\n$ poetry install\n
    1. Create a Development Branch: Make a dedicated branch for your bugfix or feature.
    $ git checkout -b name-of-your-bugfix-or-feature\n

    1. Make Changes Locally: You are now ready to implement your changes or improvements.

    2. Install and Use Pre-commit Hooks: sugar utilizes pre-commit hooks to ensure code quality. Install them locally and they will automatically run on each commit.

    $ pre-commit install\n$ pre-commit run --all-files\n

    To bypass the hooks temporarily, use git commit with --no-verify.

    1. Run Smoke Tests: Quickly validate the functionality of your changes with smoke tests.
    $ makim tests.smoke\n

    Always complement smoke tests with thorough unit testing to ensure code integrity.

    1. Unit Testing with pytest: sugar leverages pytest for unit testing, along with pytest-cov for coverage analysis. Run unit tests using:
    $ python -m pytest\n

    or

    $ makim tests.unittest\n
    1. Commit and Push Changes: Stage, commit, and push your changes to GitHub. After setting the upstream branch once, subsequent pushes only require git push.
    $ git add .\n$ git commit -m \"Detailed description of your changes.\"\n$ git push --set-upstream origin <branch name>\n
    1. Submit a Pull Request: Once your changes are pushed, go to the GitHub website to submit a pull request for review.
    "},{"location":"contributing/#release-process","title":"Release Process","text":"

    The Sugar project utilizes semantic-release to automate the release process, basing new releases on the content of commit messages.

    "},{"location":"contributing/#commit-message-format","title":"Commit Message Format","text":"

    semantic-release analyzes commit messages to assess the impact of changes made to the codebase. Adhering to a standardized commit message format allows semantic-release to automatically determine the next semantic version number, generate a comprehensive changelog, and publish the release.

    While semantic-release defaults to the Angular Commit Message Conventions, Sugar adopts the \"Conventional Commits\" standard (https://www.conventionalcommits.org/en/v1.0.0/). This standard facilitates more detailed commit messages, especially for \"breaking changes\".

    Given the project's use of the squash and merge strategy for merging pull requests, it is crucial to format the PR title according to the commit message standards.

    To aid contributors in crafting compliant commit messages, tools like commitizen and commitlint are recommended. These tools help ensure that commit messages adhere to the required format.

    The following table illustrates how different commit messages correspond to the type of release generated by semantic-release, according to its default configuration:

    Commit Message Example Release Type fix(pencil): stop graphite breaking when too much pressure Patch Release feat(pencil): add 'graphiteWidth' option Minor Release perf(pencil): optimize 'graphiteWidth' calculation Patch Release fix(pencil)!: 'graphiteWidth' option removed Major Release

    Note: Within the Conventional Commits standard, appending ! to the message prefix indicates a breaking change.

    For more details on the commit message format used by semantic-release, visit the semantic-release documentation.

    "},{"location":"example/","title":"sugar","text":"In\u00a0[\u00a0]: Copied! 
    import sugar\n
    import sugar"},{"location":"example/#sugar","title":"sugar\u00b6","text":"

    sugar is Python library that aims to do ...

    "},{"location":"example/#getting-started","title":"Getting Started\u00b6","text":"

    First, check our documentation about the installation.

    Now, let's import our library:

    "},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#stable-release","title":"Stable release","text":"

    To install sugar, run this command in your terminal:

    $ pip install containers-sugar\n

    Sugar is also available on conda-forge

    $ conda install -c conda-forge containers-sugar\n

    This is the preferred method to install sugar, as it will always install the most recent stable release.

    "},{"location":"installation/#from-sources","title":"From sources","text":"

    The sources for sugar can be downloaded from the Github repo.

    You can either clone the public repository:

    $ git clone https://github.com/osl-incubator/sugar.git\n

    Or download the tarball:

    $ curl -OJL https://github.com/osl-incubator/sugar.git/tarball/main\n

    Once you have a copy of the source, you can install it with:

    $ poetry install\n
    "}]} \ No newline at end of file