| Name | opyngpt JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | Supercharge your projects with LLMs. No API keys required. |
| upload_time | 2024-05-25 06:22:30 |
| maintainer | None |
| docs_url | None |
| author | Anas Khan |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
OpynGPT
===========================================================================
Supercharge your projects with the Power of Large Language Models.
------------------------------------------------------------------
OpynGPT is a Python module that empowers developers to effortlessly
harness the capabilities of large language models (LLMs) without the
need for authentication or API keys. Designed with simplicity and
accessibility in mind, OpynGPT supercharges your Python projects by
providing natural language generation and understanding capabilities,
making it an invaluable tool for developers of all skill levels.
Key Features
------------
- **No API Keys Required**: OpynGPT eliminates the hassle of acquiring
and managing API keys, providing a seamless and straightforward
integration with language models.
- **Natural Language Generation**: Leverage the power of LLMs to
generate human-like text responses based on your input prompts,
enabling a wide range of applications such as chatbots, content
generation, and more.
- **Beginner-Friendly**: With its intuitive interface and easy-to-use
functions, OpynGPT is the perfect starting point for developers new
to language models, allowing them to explore and experiment with
ease.
- **Command-Line Interface**: Interact with OpynGPT via the command
line for both interactive sessions and single queries, providing
flexibility and ease of use directly from the terminal.
- **Phind Model Integration**: Inspired by the renowned
`tgpt <https://github.com/aandrew-me/tgpt/>`__ project, OpynGPT
utilizes the powerful Phind Model, ensuring high-quality language
generation and understanding capabilities.
- **Open-Source**: OpynGPT is an open-source project, allowing
developers to contribute, customize, and extend its functionality to
suit their specific needs and requirements.
Getting Started
---------------
Prerequisites
~~~~~~~~~~~~~
Before diving into OpynGPT, ensure you have the following prerequisites
installed:
- Python 3.x
- The ``requests`` library (Install using ``pip install requests``)
Installation
~~~~~~~~~~~~
Installing OpynGPT is as simple as running the following command:
.. code:: bash
pip install opyngpt
To install the latest version from the GitHub repository, use:
.. code:: bash
pip install git+https://github.com/anxkhn/OpynGPT.git
Usage
-----
OpynGPT in python applications is straightforward and easy.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here’s a quick guide to get you started:
1. Import the ``prompt`` function from the OpynGPT module:
.. code:: python
from opyngpt import prompt
2. Use the ``prompt`` function to generate natural language responses
based on your input:
.. code:: python
user_input = "Write a factorial code in Python."
response = prompt(user_input)
print(response)
OpynGPT will process your input and return a relevant response,
empowering you to integrate language models into your projects
seamlessly.
OpynGPT Command Line Interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Interactive Mode:
~~~~~~~~~~~~~~~~~
To enter the interactive mode, simply open your terminal and type
``opyngpt``. Then you can enter your messages and receive responses
interactively. Type ``exit`` or press ``Ctrl+C`` to quit the interactive
mode.
Example:
::
$ opyngpt
Enter your message (type 'exit' to quit): Hello, how are you?
[OpynGPT]: I'm doing well, thank you for asking. How can I assist you today?
Enter your message (type 'exit' to quit): What is the capital of France?
[OpynGPT]: The capital of France is Paris.
Enter your message (type 'exit' to quit): exit
Single Query:
~~~~~~~~~~~~~
To make a single query, use ``opyngpt "your query"`` in your terminal,
replacing ``"your query"`` with your actual query.
Example:
.. code:: bash
$ opyngpt "What is the capital of Japan?"
[OpynGPT]: The capital of Japan is Tokyo.
Changelog
---------
Version 0.3.0
~~~~~~~~~~~~~
- Added Command Line Interface (CLI)
- Added Interactive Mode to CLI
- Improved error handling
Version 0.2.0
~~~~~~~~~~~~~
- Switched to Phind Model
Version 0.1.4
~~~~~~~~~~~~~
- Bug free working version with proper error handling
Version 0.1.0
~~~~~~~~~~~~~
- Initial release with basic functionality released as *FreeGPTpy*
Contributing
------------
We welcome contributions from the community to make OpynGPT even better.
If you’d like to contribute, please follow these steps:
1. Fork the repository
2. Create a new branch for your feature or bug fix
3. Make your changes and commit them
4. Push your changes to your forked repository
5. Submit a pull request to the main repository
License
-------
OpynGPT is licensed under the GPLv3 License. For more information about
this license, please visit `this
website <https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3>`__.
Raw data
{
"_id": null,
"home_page": null,
"name": "opyngpt",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Anas Khan",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1f/ac/b19b06b5bba88de60c3e099bfb0769f7c39f1496bb6273b59985367bf773/opyngpt-0.4.0.tar.gz",
"platform": null,
"description": "\r\nOpynGPT\r\n===========================================================================\r\n\r\nSupercharge your projects with the Power of Large Language Models.\r\n------------------------------------------------------------------\r\n\r\nOpynGPT is a Python module that empowers developers to effortlessly\r\nharness the capabilities of large language models (LLMs) without the\r\nneed for authentication or API keys. Designed with simplicity and\r\naccessibility in mind, OpynGPT supercharges your Python projects by\r\nproviding natural language generation and understanding capabilities,\r\nmaking it an invaluable tool for developers of all skill levels.\r\n\r\nKey Features\r\n------------\r\n\r\n- **No API Keys Required**: OpynGPT eliminates the hassle of acquiring\r\n and managing API keys, providing a seamless and straightforward\r\n integration with language models.\r\n- **Natural Language Generation**: Leverage the power of LLMs to\r\n generate human-like text responses based on your input prompts,\r\n enabling a wide range of applications such as chatbots, content\r\n generation, and more.\r\n- **Beginner-Friendly**: With its intuitive interface and easy-to-use\r\n functions, OpynGPT is the perfect starting point for developers new\r\n to language models, allowing them to explore and experiment with\r\n ease.\r\n- **Command-Line Interface**: Interact with OpynGPT via the command\r\n line for both interactive sessions and single queries, providing\r\n flexibility and ease of use directly from the terminal.\r\n- **Phind Model Integration**: Inspired by the renowned\r\n `tgpt <https://github.com/aandrew-me/tgpt/>`__ project, OpynGPT\r\n utilizes the powerful Phind Model, ensuring high-quality language\r\n generation and understanding capabilities.\r\n- **Open-Source**: OpynGPT is an open-source project, allowing\r\n developers to contribute, customize, and extend its functionality to\r\n suit their specific needs and requirements.\r\n\r\nGetting Started\r\n---------------\r\n\r\nPrerequisites\r\n~~~~~~~~~~~~~\r\n\r\nBefore diving into OpynGPT, ensure you have the following prerequisites\r\ninstalled:\r\n\r\n- Python 3.x\r\n- The ``requests`` library (Install using ``pip install requests``)\r\n\r\nInstallation\r\n~~~~~~~~~~~~\r\n\r\nInstalling OpynGPT is as simple as running the following command:\r\n\r\n.. code:: bash\r\n\r\n pip install opyngpt\r\n\r\nTo install the latest version from the GitHub repository, use:\r\n\r\n.. code:: bash\r\n\r\n pip install git+https://github.com/anxkhn/OpynGPT.git\r\n\r\nUsage\r\n-----\r\n\r\nOpynGPT in python applications is straightforward and easy.\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\nHere\u2019s a quick guide to get you started:\r\n\r\n1. Import the ``prompt`` function from the OpynGPT module:\r\n\r\n.. code:: python\r\n\r\n from opyngpt import prompt\r\n\r\n2. Use the ``prompt`` function to generate natural language responses\r\n based on your input:\r\n\r\n.. code:: python\r\n\r\n user_input = \"Write a factorial code in Python.\"\r\n response = prompt(user_input)\r\n print(response)\r\n\r\nOpynGPT will process your input and return a relevant response,\r\nempowering you to integrate language models into your projects\r\nseamlessly.\r\n\r\nOpynGPT Command Line Interface\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\nInteractive Mode:\r\n~~~~~~~~~~~~~~~~~\r\n\r\nTo enter the interactive mode, simply open your terminal and type\r\n``opyngpt``. Then you can enter your messages and receive responses\r\ninteractively. Type ``exit`` or press ``Ctrl+C`` to quit the interactive\r\nmode.\r\n\r\nExample:\r\n\r\n::\r\n\r\n $ opyngpt\r\n Enter your message (type 'exit' to quit): Hello, how are you?\r\n [OpynGPT]: I'm doing well, thank you for asking. How can I assist you today?\r\n Enter your message (type 'exit' to quit): What is the capital of France?\r\n [OpynGPT]: The capital of France is Paris.\r\n Enter your message (type 'exit' to quit): exit\r\n\r\nSingle Query:\r\n~~~~~~~~~~~~~\r\n\r\nTo make a single query, use ``opyngpt \"your query\"`` in your terminal,\r\nreplacing ``\"your query\"`` with your actual query.\r\n\r\nExample:\r\n\r\n.. code:: bash\r\n\r\n $ opyngpt \"What is the capital of Japan?\"\r\n [OpynGPT]: The capital of Japan is Tokyo.\r\n\r\nChangelog\r\n---------\r\n\r\nVersion 0.3.0\r\n~~~~~~~~~~~~~\r\n\r\n- Added Command Line Interface (CLI)\r\n- Added Interactive Mode to CLI\r\n- Improved error handling\r\n\r\nVersion 0.2.0\r\n~~~~~~~~~~~~~\r\n\r\n- Switched to Phind Model\r\n\r\nVersion 0.1.4\r\n~~~~~~~~~~~~~\r\n\r\n- Bug free working version with proper error handling\r\n\r\nVersion 0.1.0\r\n~~~~~~~~~~~~~\r\n\r\n- Initial release with basic functionality released as *FreeGPTpy*\r\n\r\nContributing\r\n------------\r\n\r\nWe welcome contributions from the community to make OpynGPT even better.\r\nIf you\u2019d like to contribute, please follow these steps:\r\n\r\n1. Fork the repository\r\n2. Create a new branch for your feature or bug fix\r\n3. Make your changes and commit them\r\n4. Push your changes to your forked repository\r\n5. Submit a pull request to the main repository\r\n\r\nLicense\r\n-------\r\n\r\nOpynGPT is licensed under the GPLv3 License. For more information about\r\nthis license, please visit `this\r\nwebsite <https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3>`__.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Supercharge your projects with LLMs. No API keys required.",
"version": "0.4.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ad3ba4c9ce20cdb9cd05dff75384dadb6264984f56a60e03425d3ad408494b5",
"md5": "d903d7b234806d5ea6f46309de6bd59f",
"sha256": "395bdb52d92142c0d3503fc51b2d6d70498565e5ea0f0966ee9077ca4b5727d5"
},
"downloads": -1,
"filename": "opyngpt-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d903d7b234806d5ea6f46309de6bd59f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17110,
"upload_time": "2024-05-25T06:22:28",
"upload_time_iso_8601": "2024-05-25T06:22:28.611780Z",
"url": "https://files.pythonhosted.org/packages/1a/d3/ba4c9ce20cdb9cd05dff75384dadb6264984f56a60e03425d3ad408494b5/opyngpt-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1facb19b06b5bba88de60c3e099bfb0769f7c39f1496bb6273b59985367bf773",
"md5": "3d1284894aad1ce77264e9de40c861b8",
"sha256": "559e8470668f279018872445c08879d3d365dc417a9eafedb75abd501ab16b4a"
},
"downloads": -1,
"filename": "opyngpt-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "3d1284894aad1ce77264e9de40c861b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17099,
"upload_time": "2024-05-25T06:22:30",
"upload_time_iso_8601": "2024-05-25T06:22:30.547124Z",
"url": "https://files.pythonhosted.org/packages/1f/ac/b19b06b5bba88de60c3e099bfb0769f7c39f1496bb6273b59985367bf773/opyngpt-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-25 06:22:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "opyngpt"
}
