{"id":18223059,"url":"https://github.com/samad101/chino","last_synced_at":"2025-07-19T16:34:07.349Z","repository":{"id":198962797,"uuid":"694127404","full_name":"SAMAD101/Chino","owner":"SAMAD101","description":"Chino is a terminal-based chatbot based on ChatGPT.","archived":false,"fork":false,"pushed_at":"2024-05-15T11:45:50.000Z","size":1858,"stargazers_count":21,"open_issues_count":4,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-16T17:12:17.373Z","etag":null,"topics":["chatbot","langchain","openai","python","rag"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/chinoai/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SAMAD101.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-20T11:38:18.000Z","updated_at":"2024-08-20T00:40:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"b3e744dd-c0b8-405a-a983-20b0c6ee10dd","html_url":"https://github.com/SAMAD101/Chino","commit_stats":null,"previous_names":["samad101/chino"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAMAD101%2FChino","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAMAD101%2FChino/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAMAD101%2FChino/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SAMAD101%2FChino/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SAMAD101","download_url":"https://codeload.github.com/SAMAD101/Chino/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230850403,"owners_count":18289774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","langchain","openai","python","rag"],"created_at":"2024-11-04T00:03:51.704Z","updated_at":"2024-12-22T15:32:52.413Z","avatar_url":"https://github.com/SAMAD101.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chino 🌸\n\n\u003cdiv\u003e\n  \u003cp\u003e\n  Chino is a terminal-based chatbot. Powered by OpenAI. \u003cbr\u003e\n  Uses RAG to generate responses based on user-provided documents.\n  \u003c/p\u003e\n  \u003cimg src=\"https://badgen.net/badge/status/Under Development/red?icon=lgtm\" alt=\"\"\u003e\n\n  ![Version](https://img.shields.io/badge/Version-1.0.0-brightgreen.svg)\n  ![License](https://img.shields.io/badge/License-MIT-blue.svg)\n  ![Commits](https://img.shields.io/github/commit-activity/m/SAMAD101/Chino)\n  ![Repo Size](https://img.shields.io/github/repo-size/SAMAD101/Chino)\n  ![Code Size](https://img.shields.io/github/languages/code-size/SAMAD101/Chino)\n  ![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)\n\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"320\" height=\"320\" src=\"artwork/chino_logo_1.png\" alt=\"Material Bread logo\" style=\"margin-right:20px;\"\u003e\n\u003c/p\u003e\n\n\u003chr\u003e\n\n## 🐍 Python Version Support\n\nThis project is designed to be compatible with specific versions of Python for optimal performance and stability.\n\n### Supported Python Version\n\n- **Python 3.11.7**\n\n\u003e ❗️ For the best experience and performance, it is recommended to use the version mentioned above.\n\nBefore diving into the project, ensure that you have the correct Python version installed. To check the version of Python you currently have, execute the following command in your terminal:\n\n```bash\npython --version\n```\n\n### 🐍 Installing Python 3.11.7 with `pyenv`\n\n**Protip:** Managing multiple Python versions is a breeze with [pyenv](https://github.com/pyenv/pyenv). It allows you to seamlessly switch between different Python versions without the need to reinstall them.\n\nIf you haven't installed `pyenv` yet, follow their [official guide](https://github.com/pyenv/pyenv) to set it up.\n\nOnce you have `pyenv` ready, install the recommended Python version by running:\n\n```bash\npyenv install 3.11.7\n```\n\n\u003e When you navigate to this project's directory in the future, `pyenv` will automatically select the recommended Python version, thanks to the `.python-version` file in the project root.\n\n## Installation 🛠️\n\n### Install using pip:\n```bash\npip install chinoai\n```\n\n### Build from source:\n- Clone the repository:\n  ```bash\n  git clone https://github.com/SAMAD101/Chino.git\n  ```\n\n- Navigate to the project Directory:\n  ```bash\n  cd Chino\n  ```\n\n- Install using:\n  ```bash\n  pip install .\n  ```\n\n\n# 📦 Setup for development\n\n### Setting Up the Project for development\n\n#### Contributing to the Project:\n\u003e Refer to the [Contributing Guide](CONTRIBUTING.md) for detailed information on how to contribute to this project, including setup instructions for development.\n\u003e And also refer to the [Code of Conduct](CODE_OF_CONDUCT.md) for the community guidelines.\n\n- **Fork the Repository**:\n\n  Get your own fork/copy of the project from GitHub by clicking the \"Fork\" button.\n\n- **Clone the forked Repository**\n\n  ```bash\n  git clone \u003cyour-fork-url\u003e\n  ```\n\n- **Navigate to the Project Directory**:\n\n  ```bash\n  cd Chino\n  ```\n\n- **Install the Project (from source)**:\n\n  Use PDM to run the project:\n\n  ```bash\n  python3 -m pip install -e .\n  ```\n\n- **Install pre-commit hooks**:\n\n  ```bash\n  pre-commit install\n  ```\n\n- **Run the project:**\n\n  ```bash\n  chino --help\n  ```\n\n## ⚠️ Note:\n\nYou will need an OpenAI API key to make it work. Get your API key from OpenAI website and set it as an environment variable:\n```bash\nexport OPENAI_API_KEY=\"\u003cyour_api_key\u003e\"\n```\n\n## Usage 📖\n\nCommands and options are available by running:\n\n```bash\nchino --help\n```\nFor using the Retrieval Augmented Generation (RAG) features, follow these steps:\n\n1. You will need to put your documents in the `~/.local/share/chino/data` directory. If not there, make one.\n\n2. Also,make sure you have a directory: `~/.local/share/chino/chroma`. This directory will contain the OpenAI embeddings (embedding vectors) for the documents.\n\n3. Process the documents and create the embeddings using the following command:\n    ```bash\n    chino migrate\n    ```\n\n\u003e The directory data and chroma directories will be made more configurable in the future releases.\n\n### Using Query mode:\n\nOnce your documents are processed. You can use the query mode to give prompts for the documents [RAG].\nStart Chino by running:\n```bash\nchino start\n```\nand use `\\q:` before your prompt to use it in query mode.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamad101%2Fchino","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamad101%2Fchino","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamad101%2Fchino/lists"}