Auto-generated index

Author: github-actions[bot]

docs/_index/.metadata

@@ -0,0 +1 @@
+{"name": "chrome-version", "metadata": {"name": "chrome-version", "version": "0.3.1", "classifiers": ["Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Topic :: Software Development :: Libraries :: Python Modules"], "home_page": "", "license": "MIT", "documentation_url": null, "dependencies": [], "summary": "Detect the version of Chrome installed on Windows, Linux, Mac. Cross-platform using Python, native OS detection.", "upload_time": 1704041659}, "documentation": ["<h1 align=\"center\">\n    <strong>Chrome Version</strong>\n</h1>\n<p align=\"center\">\n    <em>Get the version of Chrome installed on Windows, Linux, Mac. Cross-platform using Python, native OS detection, does not require Selenium.</em>\n</p>\n<p align=\"center\">\n    <a href=\"https://github.com/hasansezertasan/chrome-version\" target=\"_blank\">\n        <img src=\"https://img.shields.io/github/last-commit/hasansezertasan/chrome-version\" alt=\"Latest Commit\">\n    </a>\n        <img src=\"https://img.shields.io/github/workflow/status/hasansezertasan/chrome-version/Test\">\n        <img src=\"https://img.shields.io/codecov/c/github/hasansezertasan/chrome-version\">\n    <br />\n    <a href=\"https://pypi.org/project/chrome-version\" target=\"_blank\">\n        <img src=\"https://img.shields.io/pypi/v/chrome-version\" alt=\"Package version\">\n    </a>\n    <a href=\"https://pypi.org/project/chrome-version\" target=\"_blank\">\n        <img src=\"https://img.shields.io/pypi/pyversions/chrome-version\">\n    </a>\n    <img src=\"https://img.shields.io/github/license/hasansezertasan/chrome-version\">\n</p>\n\n## Installation\n\n``` bash\npip install chrome-version\n```\n\n## Usage\n\nModule:\n\n```python\n>>> import chrome_version\n>>> print(chrome_version.get_chrome_version())\n>>> '103.0.5060.114'\n```\n\nCLI:\n\n```bash\nchrome-version\n103.0.5060.114\n```\n\n## Why?\n\nAt first,\n\nI needed to get the Chrome version for a project I was working on, which was using [Undetected Chromedriver](https://github.com/ultrafunkamsterdam/undetected-chromedriver). I found the gist below.\n\nWhen I used it in a variaty of projects, I decided to turn it into a module so I'll be free of copy/paste. It only have one functionality: getting the chrome version.\n\nThen,\n\nI decided to use it to learn more about:\n\n- Using [Poetry](https://python-poetry.org/) for packaging and dependency management.\n- Using scripts for CLI.\n- Versioning.\n- License management.\n- Documentation.\n- Publishing a module on PyPI.\n- Using GitHub Actions to automate the publishing process.\n- ...\n\nFinally,\n\nNow it's kind of a playground for me to learn more...\n\n## Motivation\n\n- It might be useful for someone.\n- It's easier to pip install a module than copy/paste a gist.\n- Educational Purposes: A simple module is a good practice for me to learn how to build modules and publish them on PyPI and show others how easy it is.\n\n## Disclaimer\n\nBased on [chrome-version](https://gist.github.com/primaryobjects/d5346bf7a173dbded1a70375ff7461b4) by [Kory Becker](https://github.com/primaryobjects).\n\nThis package provides a CLI wrapper for the original project. All credit reserved to the author of the original code.\n"], "modules": [{"name": "chrome_version", "documentation": [], "functions": [], "variables": [], "classes": [], "exports": [{"name": "chrome_version.get_chrome_version", "xref": {"fqname": "chrome_version.core.get_chrome_version", "project": null}}]}, {"name": "chrome_version.main", "documentation": [], "functions": [{"name": "chrome_version.main.app", "asynchronous": false, "params": [], "returns": null, "documentation": ["Get the version of Chrome."]}], "variables": [], "classes": [], "exports": []}, {"name": "chrome_version.__main__", "documentation": [], "functions": [], "variables": [], "classes": [], "exports": []}, {"name": "chrome_version.core", "documentation": [], "functions": [{"name": "chrome_version.core.extract_version_registry", "asynchronous": false, "params": [{"name": "output", "type": null, "default": null}], "returns": null, "documentation": ["Extracts the Chrome version from the registry output."]}, {"name": "chrome_version.core.extract_version_folder", "asynchronous": false, "params": [], "returns": null, "documentation": ["Extracts the Chrome version from the folder name.\n\nCheck if the Chrome folder exists in the x32 or x64 Program Files folders."]}, {"name": "chrome_version.core.get_chrome_version", "asynchronous": false, "params": [], "returns": null, "documentation": ["Gets the Chrome version."]}], "variables": [], "classes": [], "exports": []}]}

docs/_index/bencode2.json

@@ -0,0 +1 @@
+{"name": "crimson-github-app", "metadata": {"name": "crimson-github-app", "version": "0.1.1", "classifiers": ["Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.9", "Topic :: Software Development :: Libraries :: Python Modules", "Typing :: Typed"], "home_page": null, "license": null, "documentation_url": null, "dependencies": ["crimson-intelli-type", "PyGithub"], "summary": "Your package description.", "upload_time": 1740304765}, "documentation": ["**Template README.md**\\\nThis file is from the [template repository](https://github.com/crimson206/template/blob/main/README.md).\nRewrite it for your own package.\n\n## Python Package Setup\n\n### Setup Base\n\nTo install required pip modules for `generate_toml.py`, run\n``` bash\nsource scripts/setup_base.sh\n```\n\n### User Setup\n\n- go to `generate_toml.py` file, and complete the setup in the `User Setup` session.\n\n```python\noptions = Options(\n    # Will you use the discussion session in your repo?\n    discussion=False\n)\n\n# Define the general information of your package\nkwargs = Kwargs(\n    name_space=\"None\",\n    module_name=\"None\",\n    description=\"None\",\n)\n```\n\nIf you wrote all the information, run\n```\npython generate_toml.py\n```\n\n#### Template\n\nIf you want to understand the generation process, check the `template` variable in `generate_toml.py`.\n\n### Setup Env\n\n#### Prerequisite\n\nFinish [User Setup](#user-setup) first.\nOf course, conda command must be available.\n\n#### Setup Env\n\nRun\n``` bash\nsource scripts/setup_env.sh\n```\n\nsteps\n- create an conda environment named as your $MODULE_NAME\n- activate the environment.\n- install requirements.txt\n\n#### Generate Private Env\nGenerate a private repository in this repo.\nI recommend you to write all the unstructured codes in this repo.\n\n``` bash\nsource scripts/generate_dev_repo.sh\n```\n\nIt will ask you the name of your repo, and then, generate a repo named f'{your_repo_name}-dev'.\n\n**Usage Tip**\n\nIf you wrote your codes in a wrong branch,\n- backup the files to the dev repo\n- remove changes in your main(not main branch) repo\n- move to your correct branch\n- place back the backup codes\n\n\n## Workflows\n\nI currently setup test and release workflows.\n\n**Test**\n\nIf you make a PR with the patterns [ main, develop, 'release/*', 'feature/*' ],\n\nIt will perform your unittest in [\"3.9\", \"3.10\", \"3.11\"]\n\n**Release**\n\nrequired secret : PYPI_API_TOKEN\n\nI usually make PRs only when I start release branches.\nrelease workflow is not conducted automatically. If you think your branch is ready to be published, \n\n- go to https://github.com/{github_id}/{repo_name}/actions/workflows/release.yaml\n- find the button, 'Run workflow'\n- select the branch to publish. In my case, release/x.x.x\n"], "modules": [{"name": "crimson.github_app.loader", "documentation": ["Import\n---\n``` python\nimport (\n    save_contents_to_folder,\n    download_repo_contents\n)\n```\n\nDescription\n---\nA Python package to interact with GitHub API and download repository contents."], "functions": [{"name": "crimson.github_app.loader.save_contents_to_folder", "asynchronous": false, "params": [{"name": "contents", "type": {"name": "List", "xref": {"fqname": "typing.List", "project": "--std--"}, "params": [{"name": "ContentFile", "xref": {"fqname": "github.ContentFile.ContentFile", "project": "pygithub"}, "params": null}]}, "default": null}, {"name": "output_dir", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": null, "documentation": ["Saves file contents retrieved from GitHub API to a local folder.\n\nArgs:\n    contents: List of ContentFile objects retrieved from GitHub API\n    output_dir: Base directory path where files will be saved"]}, {"name": "crimson.github_app.loader.download_repo_contents", "asynchronous": false, "params": [{"name": "repo_name", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}, {"name": "dir_in_repo", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}, {"name": "output_dir", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": "..."}, {"name": "git_token", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": "..."}], "returns": null, "documentation": ["Downloads files from a specific directory in a GitHub repository to a local folder.\n\nArgs:\n    repo_name: Repository name (e.g., \"username/repo_name\")\n    dir_in_repo: Path to the directory in the repository to download files from\n    output_dir: Base directory path where files will be saved\n    git_token: GitHub token. It is required if the repository is private"]}], "variables": [], "classes": [], "exports": []}, {"name": "crimson.github_app", "documentation": ["Import\n---\n``` python\nimport (\n    download_repo_contents\n)\n```\n\nDescription\n---\nShort cuts for frequently used functions in the package."], "functions": [], "variables": [], "classes": [], "exports": [{"name": "crimson.github_app.download_repo_contents", "xref": {"fqname": "crimson.github_app.loader.download_repo_contents", "project": null}}]}, {"name": "crimson.github_app.getter", "documentation": ["Import\n---\n``` python\nimport (\n    get_git_repos,\n    get_repo_contents,\n    get_repo_content,\n    get_git_repo\n)\n```\n---\n\nDescription\n---\nA Python package to interact with GitHub API and get repository contents."], "functions": [{"name": "crimson.github_app.getter.get_git_repos", "asynchronous": false, "params": [{"name": "app", "type": {"name": "Github", "xref": {"fqname": "github.Github", "project": "pygithub"}, "params": null}, "default": null}, {"name": "user_id", "type": {"name": "Optional", "xref": {"fqname": "typing.Optional", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}]}, "default": "..."}], "returns": {"name": "Dict", "xref": {"fqname": "typing.Dict", "project": "--std--"}, "params": [{"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, {"name": "Repository", "xref": {"fqname": "github.Repository.Repository", "project": "pygithub"}, "params": null}]}, "documentation": ["If your app is logged in, use it without user_id to keep the authority."]}, {"name": "crimson.github_app.getter.get_git_repo", "asynchronous": false, "params": [{"name": "repo_name", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}, {"name": "git_token", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": "..."}], "returns": {"name": "Repository", "xref": {"fqname": "github.Repository.Repository", "project": "pygithub"}, "params": null}, "documentation": ["Args:\n    repo_name: full name of the repository, e.g., \"username/repo_name\"\n    git_token: github token. It is required if the repository is private\n    \nReturns:\n            Repository: github repository object"]}, {"name": "crimson.github_app.getter.get_repo_contents", "asynchronous": false, "params": [{"name": "repo", "type": {"name": "Repository", "xref": {"fqname": "github.Repository.Repository", "project": "pygithub"}, "params": null}, "default": null}, {"name": "dir", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "List", "xref": {"fqname": "typing.List", "project": "--std--"}, "params": [{"name": "ContentFile", "xref": {"fqname": "github.ContentFile.ContentFile", "project": "pygithub"}, "params": null}]}, "documentation": []}, {"name": "crimson.github_app.getter.get_repo_content", "asynchronous": false, "params": [{"name": "repo", "type": {"name": "Repository", "xref": {"fqname": "github.Repository.Repository", "project": "pygithub"}, "params": null}, "default": null}, {"name": "path", "type": {"name": "str", "xref": {"fqname": "functions.str", "project": "--std--"}, "params": null}, "default": null}], "returns": {"name": "ContentFile", "xref": {"fqname": "github.ContentFile.ContentFile", "project": "pygithub"}, "params": null}, "documentation": []}], "variables": [], "classes": [], "exports": []}]}