# Codegyan Python Library
A Python library to interact with the Codegyan API.
## Installation
```bash
pip install codegyan
```
## Usage
Before using the Pakage, you need to obtain an API key and client ID from Codegyan. Follow these steps to get your API credentials:
1. **Sign Up/Login**: If you don't have an account, sign up for a [Codegyan account](https://codegyan.in/account/signup.php). If you already have an account, log in to your dashboard.
2. **Get Credentials**: Once logged in, navigate to the [Developer Console](https://developer.codegyan.in/) or API settings in your account dashboard. Here, you will find your API key and client ID. Copy these credentials and use them when initializing the Pakage in your code.
Here's an example of how to initialize the npm pakage with your API key and Client ID:
```python
from codegyan import Codegyan
# Define your API credentials
api_key = "YOUR API KEY"
client_id = "YOUR CLIENT ID"
# Initialize the Codegyan client
client = Codegyan(api_key, client_id)
# Define the language and code to be compiled
lang = "python"
code = 'print("Hello, World!")'
# Use the Compiler API to compile the code
result = client.compilerApiClient.compile(lang, code)
print(result)
```
Replace **YOUR_API_KEY** and **YOUR_CLIENT_ID** with your actual API key and Client ID provided by Codegyan. Pass the code you want to compile to the compile function.
## Tests
To run the unit tests, use the following command:
```
python -m unittest discover tests
```
Make sure to replace tests with the actual path to your test directory if it's different.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
## License
This project is licensed under the **[MIT license](https://opensource.org/licenses/MIT)**. See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/Codegyan-LLC/codegyan-python",
"name": "codegyan",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "codegyan, api, codex, client, sdk, prathmeshyelne",
"author": "Prathmesh Yelne",
"author_email": "prathmeshyelne@codegyan.in",
"download_url": "https://files.pythonhosted.org/packages/dd/1c/0357ce1aa285a064c3e7d70432c9b3f38dc049f9491ac4b5f5613eb9be23/codegyan-1.0.0.tar.gz",
"platform": null,
"description": "# Codegyan Python Library\n\nA Python library to interact with the Codegyan API.\n\n\n\n\n\n\n\n## Installation\n\n```bash\npip install codegyan\n```\n## Usage\nBefore using the Pakage, you need to obtain an API key and client ID from Codegyan. Follow these steps to get your API credentials:\n\n1. **Sign Up/Login**: If you don't have an account, sign up for a [Codegyan account](https://codegyan.in/account/signup.php). If you already have an account, log in to your dashboard.\n\n2. **Get Credentials**: Once logged in, navigate to the [Developer Console](https://developer.codegyan.in/) or API settings in your account dashboard. Here, you will find your API key and client ID. Copy these credentials and use them when initializing the Pakage in your code.\n\nHere's an example of how to initialize the npm pakage with your API key and Client ID:\n\n```python\nfrom codegyan import Codegyan\n\n# Define your API credentials\napi_key = \"YOUR API KEY\"\nclient_id = \"YOUR CLIENT ID\"\n\n# Initialize the Codegyan client\nclient = Codegyan(api_key, client_id)\n\n# Define the language and code to be compiled\nlang = \"python\"\ncode = 'print(\"Hello, World!\")'\n\n# Use the Compiler API to compile the code\nresult = client.compilerApiClient.compile(lang, code)\nprint(result)\n\n```\nReplace **YOUR_API_KEY** and **YOUR_CLIENT_ID** with your actual API key and Client ID provided by Codegyan. Pass the code you want to compile to the compile function.\n\n\n## Tests\nTo run the unit tests, use the following command:\n\n```\npython -m unittest discover tests\n```\nMake sure to replace tests with the actual path to your test directory if it's different.\n\n## Contributing\nContributions are welcome! Please open an issue or submit a pull request on GitHub.\n\n## License\nThis project is licensed under the **[MIT license](https://opensource.org/licenses/MIT)**. See the LICENSE file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python library to interact with the Codegyan API",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Codegyan-LLC/codegyan-python"
},
"split_keywords": [
"codegyan",
" api",
" codex",
" client",
" sdk",
" prathmeshyelne"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32a0ecba39eeda99cb47a311497119ceccebbcea5b395cefa4e037da81589c81",
"md5": "09dc5acff66b96b803ac3cd4a05df4b5",
"sha256": "7410ca78b7a906aebcae2ba7cff3d1fdfb352d26cf808de616002511345adf69"
},
"downloads": -1,
"filename": "codegyan-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09dc5acff66b96b803ac3cd4a05df4b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8373,
"upload_time": "2024-06-17T09:53:23",
"upload_time_iso_8601": "2024-06-17T09:53:23.651430Z",
"url": "https://files.pythonhosted.org/packages/32/a0/ecba39eeda99cb47a311497119ceccebbcea5b395cefa4e037da81589c81/codegyan-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd1c0357ce1aa285a064c3e7d70432c9b3f38dc049f9491ac4b5f5613eb9be23",
"md5": "4d5f6cb75b3e4ac22e13ce658fed1202",
"sha256": "3cc9704a21e20298c5dac84740e7f879d13b31cf5a9062d0bac234dc099f4452"
},
"downloads": -1,
"filename": "codegyan-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4d5f6cb75b3e4ac22e13ce658fed1202",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8008,
"upload_time": "2024-06-17T09:53:25",
"upload_time_iso_8601": "2024-06-17T09:53:25.691246Z",
"url": "https://files.pythonhosted.org/packages/dd/1c/0357ce1aa285a064c3e7d70432c9b3f38dc049f9491ac4b5f5613eb9be23/codegyan-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-17 09:53:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Codegyan-LLC",
"github_project": "codegyan-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "codegyan"
}
JSON
