micoo 0.1.0__py3-none-any.whl

micoo/__init__.py

@@ -0,0 +1 @@
+"""Entry point for the micoo application."""

micoo/__main__.py

@@ -0,0 +1,6 @@
+"""Module entrypoint."""
+
+from micoo.main import app
+
+if __name__ == "__main__":
+    app()

micoo/_version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)

micoo/config.py

@@ -0,0 +1,24 @@
+"""Python module for micoo configuration and paths."""
+
+from pathlib import Path
+
+from platformdirs import PlatformDirs
+
+dirs: PlatformDirs = PlatformDirs(
+    appname="micoo",
+    appauthor=False,
+    version=None,
+    roaming=False,
+    ensure_exists=True,
+)
+"""Platform-specific directories for the application."""
+repository_path: Path = dirs.user_cache_path / "mise-cookbooks"
+"""Path to the local repository of Mise cookbooks."""
+log_file_path: Path = dirs.user_log_path / "micoo.log"
+"""Path to the log file."""
+cookbooks_repository_url: str = "https://github.com/hasansezertasan/mise-cookbooks"
+"""URL of the remote repository of Mise cookbooks."""
+micoo_repository_url: str = "https://github.com/hasansezertasan/micoo"
+"""URL of the remote repository of micoo."""
+file_extension: str = ".mise.toml"
+"""File extension for globing cookbooks."""

micoo/logging_setup.py

@@ -0,0 +1,16 @@
+"""Set up logging for the micoo application."""
+
+import logging
+
+from micoo.config import log_file_path
+
+logger = logging.getLogger("micoo")
+logger.setLevel(logging.ERROR)
+# Create a file handler that logs error messages
+file_handler = logging.FileHandler(log_file_path)
+file_handler.setLevel(logging.ERROR)
+# Create a formatter and set it for the handler
+formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+file_handler.setFormatter(formatter)
+# Add the handler to the logger
+logger.addHandler(file_handler)

micoo/main.py

@@ -0,0 +1,283 @@
+"""micoo is a command-line tool for easily accessing mise cookbooks."""
+
+from __future__ import annotations
+
+import platform
+from importlib.metadata import version
+from typing import Union
+
+import typer
+from git import GitCommandError, Repo
+
+from micoo.config import (
+    cookbooks_repository_url,
+    dirs,
+    file_extension,
+    micoo_repository_url,
+    repository_path,
+)
+from micoo.logging_setup import logger
+
+app = typer.Typer(
+    name="micoo is a command-line tool for easily accessing mise cookbooks.",
+    no_args_is_help=True,
+    rich_markup_mode="rich",
+)
+
+
+cookbook_template = """### Generated by micoo ({micoo_repository_url})
+### {remote_web_root}
+{content}
+"""
+
+
+@app.command()
+def update() -> None:
+    """Clone or fetch the `mise-cookbooks` repository.
+
+    Update the repository to the latest version:
+        micoo update
+
+    Example output:
+        Repository pulled successfully.
+    """
+    repo: Union[Repo, None] = None
+    try:
+        msg = f"Cloning repository from {cookbooks_repository_url} to {repository_path}"
+        if not repository_path.exists():
+            logger.info(msg)
+            repo = Repo.clone_from(
+                url=cookbooks_repository_url,
+                to_path=repository_path,
+                branch="main",
+            )
+            typer.echo("Repository cloned successfully.")
+            return
+        msg = f"Repository already exists at {repository_path}, pulling latest changes."
+        logger.info(msg)
+        repo = Repo(repository_path)
+        repo.remotes[0].pull()
+        typer.echo("Repository pulled successfully.")
+    except GitCommandError as e:
+        logger.error(f"Git command error: {e}")
+        typer.echo("An error occurred while cloning/pulling the repository.")
+    except Exception as e:  # noqa: BLE001
+        logger.error(f"An unexpected error occurred: {e}")
+        typer.echo("An error occurred while cloning/pulling the repository.")
+
+
+@app.command(name="list")
+def list_cookbooks() -> None:
+    """List the available mise cookbooks.
+
+    List all available cookbooks:
+        micoo list
+
+    Example output:
+        Available cookbooks:
+        - terraform
+        - python
+        - cpp
+        - pnpm
+        - node
+        - ruby-on-rails
+        - opentofu
+    """
+    if not repository_path.exists():
+        typer.echo("No cookbooks found. Please clone/pull the repository first.")
+        return
+    cookbooks = repository_path.rglob(pattern="*" + file_extension)
+    if not cookbooks:
+        typer.echo("No cookbooks found.")
+    else:
+        typer.echo("Available cookbooks:")
+        for cookbook_path in cookbooks:
+            typer.echo(f"- {cookbook_path.name[:-10]}")
+
+
+@app.command()
+def search(
+    name: str = typer.Argument(..., help="Name of the cookbook to search for."),
+) -> None:
+    """Search for a mise cookbook.
+
+    Search for a "generic" cookbook:
+        micoo search generic
+
+    Example output:
+        No cookbooks found matching 'generic'.
+
+    Search for a cookbook that contains "on" in its name:
+        micoo search on
+
+    Example output:
+        python
+        ruby-on-rails
+    """
+    if not repository_path.exists():
+        typer.echo("No cookbooks found. Please fetch the repository first.")
+        return
+
+    found = False
+    search_term = name.lower()
+    for cookbook_path in repository_path.rglob(pattern="*" + file_extension):
+        filename = cookbook_path.name[: -len(file_extension)]
+        if search_term in filename.lower():
+            typer.echo(filename)
+            found = True
+    if not found:
+        typer.echo(f"No cookbooks found matching '{name}'.")
+
+
+@app.command()
+def dump(
+    name: str = typer.Argument(
+        ..., help="Name of the cookbook to dump.", metavar="python"
+    ),
+) -> None:
+    """Dump a mise cookbook.
+
+    Dump a specific cookbook to the console:
+        micoo dump python
+
+    Example output:
+        ### Generated by micoo (https://github.com/hasansezertasan/micoo)
+        ### https://raw.github.com/hasansezertasan/mise-cookbooks/81747c2e983fa1278005c8cb8b0e311a7726923a/python.mise.toml
+        min_version = "2024.9.5"
+
+        [env]
+        # Use the project name derived from the current directory
+        PROJECT_NAME = "{{ config_root | basename }}"
+
+        # Automatic virtualenv activation
+        _.python.venv = { path = ".venv", create = true }
+
+        [tools]
+        python = "{{ get_env(name='PYTHON_VERSION', default='3.11') }}"
+        ruff = "latest"
+
+        [tasks.install]
+        description = "Install dependencies"
+        alias = "i"
+        run = "uv pip install -r requirements.txt"
+
+        [tasks.run]
+        description = "Run the application"
+        run = "python app.py"
+
+        [tasks.test]
+        description = "Run tests"
+        run = "pytest tests/"
+
+        [tasks.lint]
+        description = "Lint the code"
+        run = "ruff src/"
+
+        [tasks.info]
+        description = "Print project information"
+        run = '''
+        echo "Project: $PROJECT_NAME"
+        echo "Virtual Environment: $VIRTUAL_ENV"
+        '''
+
+
+    Dump a specific cookbook to a file:
+        micoo dump python > .mise.toml
+    """
+    cookbook_path = repository_path / (name + file_extension)
+    if not cookbook_path.exists():
+        typer.echo(f"Cookbook '{name}' not found.")
+        return
+
+    repo = Repo(repository_path)
+    revision_hash = repo.head.commit.hexsha
+
+    with cookbook_path.open() as f:
+        content = f.read()
+    repository_url_raw = cookbooks_repository_url.replace(
+        "https://github.com",
+        "https://raw.github.com",
+    )
+    remote_web_root = (
+        repository_url_raw + "/" + revision_hash + "/" + name + file_extension
+    )
+    typer.echo(
+        cookbook_template.format(
+            micoo_repository_url=micoo_repository_url,
+            remote_web_root=remote_web_root,
+            content=content,
+        ),
+    )
+
+
+@app.command()
+def root() -> None:
+    """Show the path to the micoo boilerplates directory.
+
+    Show the root directory:
+        micoo root
+
+    Example output:
+        /Users/hasansezertasan/Library/Application Support/micoo/mise-cookbooks
+
+    Open the root directory in a file manager:
+        open $(micoo root)
+
+    """
+    typer.echo(dirs.user_data_path)
+
+
+@app.command()
+def remote() -> None:
+    """Show the URL to the remote repository.
+
+    Show the remote URL
+        micoo remote
+
+    Example output:
+        https://github.com/hasansezertasan/mise-cookbooks
+
+    Open the remote URL in a web browser
+        open $(micoo remote)
+    """
+    typer.echo(cookbooks_repository_url)
+
+
+@app.command(name="version")
+def show_version() -> None:
+    """Show the current version number of micoo.
+
+    Show the version number:
+        micoo version
+
+    Example output:
+        0.1.dev0+d20250726
+    """
+    typer.echo(version("micoo"))
+
+
+@app.command()
+def info() -> None:
+    """Display information about the micoo application.
+
+    Show application information:
+        micoo info
+
+    Example output:
+        Application Version: 0.1.dev0+d20250726
+        Python Version: 3.8.20 (CPython)
+        Platform: Darwin
+        Repository Path: /Users/hasansezertasan/Library/Caches/micoo/mise-cookbooks
+        Repository URL: https://github.com/hasansezertasan/mise-cookbooks/tree/81747c2e983fa1278005c8cb8b0e311a7726923a
+    """
+    python_version = platform.python_version()
+    python_implementation = platform.python_implementation()
+    typer.echo(f"Application Version: {version('micoo')}")
+    typer.echo(f"Python Version: {python_version} ({python_implementation})")
+    typer.echo(f"Platform: {platform.system()}")
+    typer.echo(f"Repository Path: {repository_path}")
+    url = "N/A"
+    if repository_path.exists():
+        repo = Repo(repository_path)
+        url = f"{cookbooks_repository_url}/tree/{repo.head.commit.hexsha}"
+    typer.echo(f"Repository URL: {url}")

micoo-0.1.0.dist-info/METADATA

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: micoo
+Version: 0.1.0
+Summary: micoo is a command-line tool for easily accessing mise cookbooks
+Project-URL: Documentation, https://github.com/hasansezertasan/micoo#readme
+Project-URL: Homepage, https://github.com/hasansezertasan/micoo
+Project-URL: Source, https://github.com/hasansezertasan/micoo
+Author-email: Hasan Sezer Taşan <hasansezertasan@gmail.com>
+Maintainer-email: hasansezertasan <hasansezertasan@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: boilerplate,cli,command-line,cookbook,mise,scaffold,template
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Terminals
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: gitpython>=3.0.0
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: pydantic-settings>=2.8.1
+Requires-Dist: typer>=0.16.0
+Description-Content-Type: text/markdown
+
+# micoo: quick access to `mise-cookbooks`
+
+<!-- TODO: Make it work, make it right, make it fast. -->
+
+[![CI](https://github.com/hasansezertasan/micoo/actions/workflows/ci.yml/badge.svg)](https://github.com/hasansezertasan/micoo/actions/workflows/ci.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/micoo.svg)](https://pypi.org/project/micoo)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/micoo.svg)](https://pypi.org/project/micoo)
+[![License - MIT](https://img.shields.io/github/license/hasansezertasan/micoo.svg)](https://opensource.org/licenses/MIT)
+[![Latest Commit](https://img.shields.io/github/last-commit/hasansezertasan/micoo)][micoo]
+
+<!-- [![Coverage](https://codecov.io/gh/hasansezertasan/micoo/graph/badge.svg?token=XXXXXXXXXXX)](https://codecov.io/gh/hasansezertasan/micoo) -->
+
+<!-- [![Coverage](https://img.shields.io/codecov/c/github/hasansezertasan/micoo)](https://codecov.io/gh/hasansezertasan/micoo) -->
+
+<!-- [![Coverage](https://codecov.io/gh/hasansezertasan/micoo/branch/main/graph/badge.svg)](https://codecov.io/gh/hasansezertasan/micoo) -->
+
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
+[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![GitHub Tag](https://img.shields.io/github/tag/hasansezertasan/micoo?include_prereleases=&sort=semver&color=black)](https://github.com/hasansezertasan/micoo/releases/)
+
+[![Downloads](https://pepy.tech/badge/micoo)](https://pepy.tech/project/micoo)
+[![Downloads/Month](https://pepy.tech/badge/micoo/month)](https://pepy.tech/project/micoo)
+[![Downloads/Week](https://pepy.tech/badge/micoo/week)](https://pepy.tech/project/micoo)
+
+`micoo` (short for **mise cookbooks**) is a :zap: command-line tool that makes it easy to access [mise] configuration files from [mise-cookbooks] :books:.
+
+## Typical Usage :rocket:
+
+```sh
+# List available cookbooks
+micoo list
+
+# Create a new mise.toml with a cookbook
+micoo dump python > mise.toml
+```
+
+## Features :sparkles:
+
+- 🚀 Quick access to [mise-cookbooks]
+- 📚 Easy cookbook listing and content viewing
+- 💾 Simple dumping of cookbooks to mise.toml
+- 🔄 Repository cloning and updating
+- 🌐 Browser integration for quick repository access
+
+## Installation :package:
+
+There are several ways to install `micoo`! :rocket: I recommend using (obviously) [mise] :hammer_and_wrench:. Here's how to do it:
+
+```sh
+mise install pipx:micoo
+```
+
+Alternatively, you can install it using `uv tool install micoo` :jigsaw:
+
+```sh
+uv tool install micoo
+```
+
+## Command Reference :book:
+
+Here is the output of the `micoo --help` command:
+
+```sh
+ Usage: micoo [OPTIONS] COMMAND [ARGS]...
+╭─ Options ─────────────────────────────────────────────────────────────────────────────╮
+│ --install-completion          Install completion for the current shell.               │
+│ --show-completion             Show completion for the current shell, to copy it or    │
+│                               customize the installation.                             │
+│ --help                        Show this message and exit.                             │
+╰───────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ────────────────────────────────────────────────────────────────────────────╮
+│ update    Clone or fetch the `mise-cookbooks` repository.                             │
+│ list      List the available mise cookbooks.                                          │
+│ search    Search for a mise cookbook.                                                 │
+│ dump      Dump a mise cookbook.                                                       │
+│ root      Show the path to the micoo boilerplates directory.                          │
+│ remote    Show the URL to the remote repository.                                      │
+│ version   Show the current version number of micoo.                                   │
+│ info      Display information about the micoo application.                            │
+╰───────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+## Usage :hammer_and_wrench:
+
+You can use the `micoo` command to interact with [mise-cookbooks]. Here are some common commands:
+
+List all available cookbooks:
+
+```sh
+micoo list
+```
+
+This will output:
+
+```sh
+Available cookbooks:
+- terraform
+- python
+- cpp
+- pnpm
+- node
+- ruby-on-rails
+- opentofu
+```
+
+Dump a specific cookbook to a `mise.toml` file:
+
+```sh
+micoo dump python > mise.toml
+```
+
+Open the [mise-cookbooks] repository in the browser:
+
+```sh
+open $(micoo remote)
+```
+
+Open the cloned repository in the file manager:
+
+```sh
+open $(micoo root)
+```
+
+Show the current version of `micoo`:
+
+```sh
+micoo version
+```
+
+Show the information about the `micoo` application:
+
+```sh
+micoo info
+```
+
+## Support :heart:
+
+If you have any questions or need help, feel free to open an issue on the [GitHub repository][micoo].
+
+## Author :person_with_crown:
+
+This project is maintained by [Hasan Sezer Taşan][author], It's me :wave:
+
+## Contributing :heart:
+
+Any contributions are welcome! Please follow the [Contributing Guidelines](https://github.com/hasansezertasan/micoo/tree/main./CONTRIBUTING.md) to contribute to this project.
+
+## Development :toolbox:
+
+To set up the development environment:
+
+```sh
+# Clone the repository
+git clone https://github.com/hasansezertasan/micoo.git
+cd micoo
+
+# Install development dependencies
+uv sync
+
+# Update the code...
+
+# Run tests
+uv run --locked tox run
+
+# Add a new git tag.
+git tag -a v0.1.0 -m "bump: version 0.0.0 → 0.1.0"
+
+# Build the package
+uv build
+```
+
+## Related Projects :chains:
+
+- [mise] - The official mise project
+- [mise-cookbooks] - Collection of mise cookbooks
+
+## Changelog :memo:
+
+For a detailed list of changes, please refer to the [CHANGELOG](https://github.com/hasansezertasan/micoo/tree/main./CHANGELOG.md).
+
+## License :scroll:
+
+This project is licensed under the [MIT License](https://opensource.org/license/MIT).
+
+<!-- Refs -->
+
+[mise-cookbooks]: https://github.com/hasansezertasan/mise-cookbooks
+[mise]: https://github.com/jdx/mise
+[author]: https://github.com/hasansezertasan
+[micoo]: https://github.com/hasansezertasan/micoo

micoo-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+micoo/__init__.py,sha256=m39EhV293qWLw_lB-_syDz_y5b2NO32CLzPgljFINpQ,45
+micoo/__main__.py,sha256=uXzo5xrEHV5S6FJ3UTfWbbbMtLeo1zFNiu2ZOFVg75g,91
+micoo/_version.py,sha256=-LyU5F1uZDjn6Q8_Z6-_FJt_8RE4Kq9zcKdg1abSSps,511
+micoo/config.py,sha256=HA4RI6cqeOgfn650RkmYQAy2SyhpAZE3uFfX2-0QQqE,852
+micoo/logging_setup.py,sha256=HZDMu-GEu2m52Pgjo9Nj32XOgFBHin9_wM1d-8W741c,543
+micoo/main.py,sha256=uBiqjxb-TSmg9HwQjT207OkXS_LctCTFczhIn7TeVwQ,7890
+micoo/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+micoo-0.1.0.dist-info/METADATA,sha256=L3NwjjPv8HGEwXAXQ8ImRDcwFB9mzL9UZllOSac1PaU,8980
+micoo-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+micoo-0.1.0.dist-info/entry_points.txt,sha256=TrTKBA54I9cnPpDhVny0Iyh_Zk_jlQb2KOXpFB5l2YA,41
+micoo-0.1.0.dist-info/licenses/LICENSE,sha256=SvTnky8ZKfPQNlBre40E-1L8ajWf6BGUbk39FhJJbik,1075
+micoo-0.1.0.dist-info/RECORD,,

micoo-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

micoo-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+micoo = micoo.main:app

micoo-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hasan Sezer Taşan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.