ngpt 2.11.4__tar.gz → 2.11.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. {ngpt-2.11.4 → ngpt-2.11.5}/PKG-INFO +4 -1
  2. {ngpt-2.11.4 → ngpt-2.11.5}/README.md +3 -0
  3. {ngpt-2.11.4 → ngpt-2.11.5}/docs/installation.md +13 -0
  4. {ngpt-2.11.4 → ngpt-2.11.5}/docs/usage/cli_usage.md +3 -0
  5. ngpt-2.11.5/ngpt/__main__.py +4 -0
  6. {ngpt-2.11.4 → ngpt-2.11.5}/pyproject.toml +1 -1
  7. {ngpt-2.11.4 → ngpt-2.11.5}/uv.lock +1 -1
  8. {ngpt-2.11.4 → ngpt-2.11.5}/.github/workflows/python-publish.yml +0 -0
  9. {ngpt-2.11.4 → ngpt-2.11.5}/.gitignore +0 -0
  10. {ngpt-2.11.4 → ngpt-2.11.5}/.python-version +0 -0
  11. {ngpt-2.11.4 → ngpt-2.11.5}/COMMIT_GUIDELINES.md +0 -0
  12. {ngpt-2.11.4 → ngpt-2.11.5}/CONTRIBUTING.md +0 -0
  13. {ngpt-2.11.4 → ngpt-2.11.5}/LICENSE +0 -0
  14. {ngpt-2.11.4 → ngpt-2.11.5}/docs/CONTRIBUTING.md +0 -0
  15. {ngpt-2.11.4 → ngpt-2.11.5}/docs/LICENSE.md +0 -0
  16. {ngpt-2.11.4 → ngpt-2.11.5}/docs/README.md +0 -0
  17. {ngpt-2.11.4 → ngpt-2.11.5}/docs/_config.yml +0 -0
  18. {ngpt-2.11.4 → ngpt-2.11.5}/docs/api/README.md +0 -0
  19. {ngpt-2.11.4 → ngpt-2.11.5}/docs/api/cli.md +0 -0
  20. {ngpt-2.11.4 → ngpt-2.11.5}/docs/api/cli_config.md +0 -0
  21. {ngpt-2.11.4 → ngpt-2.11.5}/docs/api/client.md +0 -0
  22. {ngpt-2.11.4 → ngpt-2.11.5}/docs/api/config.md +0 -0
  23. {ngpt-2.11.4 → ngpt-2.11.5}/docs/assets/css/style.scss +0 -0
  24. {ngpt-2.11.4 → ngpt-2.11.5}/docs/configuration.md +0 -0
  25. {ngpt-2.11.4 → ngpt-2.11.5}/docs/examples/README.md +0 -0
  26. {ngpt-2.11.4 → ngpt-2.11.5}/docs/examples/advanced.md +0 -0
  27. {ngpt-2.11.4 → ngpt-2.11.5}/docs/examples/basic.md +0 -0
  28. {ngpt-2.11.4 → ngpt-2.11.5}/docs/examples/cli_components.md +0 -0
  29. {ngpt-2.11.4 → ngpt-2.11.5}/docs/examples/integrations.md +0 -0
  30. {ngpt-2.11.4 → ngpt-2.11.5}/docs/overview.md +0 -0
  31. {ngpt-2.11.4 → ngpt-2.11.5}/docs/usage/README.md +0 -0
  32. {ngpt-2.11.4 → ngpt-2.11.5}/docs/usage/cli_config.md +0 -0
  33. {ngpt-2.11.4 → ngpt-2.11.5}/docs/usage/cli_framework.md +0 -0
  34. {ngpt-2.11.4 → ngpt-2.11.5}/docs/usage/library_usage.md +0 -0
  35. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/__init__.py +0 -0
  36. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/__init__.py +0 -0
  37. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/args.py +0 -0
  38. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/config_manager.py +0 -0
  39. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/formatters.py +0 -0
  40. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/interactive.py +0 -0
  41. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/main.py +0 -0
  42. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/modes/__init__.py +0 -0
  43. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/modes/chat.py +0 -0
  44. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/modes/code.py +0 -0
  45. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/modes/shell.py +0 -0
  46. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/modes/text.py +0 -0
  47. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/renderers.py +0 -0
  48. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli/ui.py +0 -0
  49. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/cli.py +0 -0
  50. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/client.py +0 -0
  51. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/utils/__init__.py +0 -0
  52. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/utils/cli_config.py +0 -0
  53. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/utils/config.py +0 -0
  54. {ngpt-2.11.4 → ngpt-2.11.5}/ngpt/utils/log.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ngpt
3
- Version: 2.11.4
3
+ Version: 2.11.5
4
4
  Summary: A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints.
5
5
  Project-URL: Homepage, https://github.com/nazdridoy/ngpt
6
6
  Project-URL: Repository, https://github.com/nazdridoy/ngpt
@@ -79,6 +79,9 @@ uv tool install ngpt
79
79
  # Chat with default settings
80
80
  ngpt "Tell me about quantum computing"
81
81
 
82
+ # Alternatively, run as a Python module
83
+ python -m ngpt "Tell me about quantum computing"
84
+
82
85
  # Start an interactive chat session with conversation memory
83
86
  ngpt -i
84
87
 
@@ -44,6 +44,9 @@ uv tool install ngpt
44
44
  # Chat with default settings
45
45
  ngpt "Tell me about quantum computing"
46
46
 
47
+ # Alternatively, run as a Python module
48
+ python -m ngpt "Tell me about quantum computing"
49
+
47
50
  # Start an interactive chat session with conversation memory
48
51
  ngpt -i
49
52
 
@@ -148,6 +148,19 @@ ngpt --version
148
148
 
149
149
  You should see the version number of nGPT displayed.
150
150
 
151
+ Alternatively, you can run nGPT as a Python module:
152
+
153
+ ```bash
154
+ python -m ngpt --version
155
+ ```
156
+
157
+ This method is especially useful when:
158
+ - The `ngpt` command is not in your PATH
159
+ - You're working in a virtual environment
160
+ - You want to ensure you're using the correct Python interpreter
161
+
162
+ All the functionality available through the `ngpt` command is also available through `python -m ngpt`.
163
+
151
164
  ## Updating nGPT
152
165
 
153
166
  To update to the latest version:
@@ -744,6 +744,9 @@ If the `ngpt` command is not found after installation:
744
744
 
745
745
  - Ensure Python's bin directory is in your PATH
746
746
  - Try using `python -m ngpt` instead of just `ngpt`
747
+ - This works because of the package's `__main__.py` module
748
+ - It's particularly useful in virtual environments or when the command isn't in your PATH
749
+ - All the same arguments and options work with this method: `python -m ngpt -i --prettify`
747
750
 
748
751
  ## Tips and Best Practices
749
752
 
@@ -0,0 +1,4 @@
1
+ from .cli import main
2
+
3
+ if __name__ == "__main__":
4
+ main()
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "ngpt"
3
- version = "2.11.4"
3
+ version = "2.11.5"
4
4
  description = "A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints."
5
5
  authors = [
6
6
  {name = "nazDridoy", email = "nazdridoy399@gmail.com"},
@@ -134,7 +134,7 @@ wheels = [
134
134
 
135
135
  [[package]]
136
136
  name = "ngpt"
137
- version = "2.11.4"
137
+ version = "2.11.5"
138
138
  source = { editable = "." }
139
139
  dependencies = [
140
140
  { name = "prompt-toolkit" },
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes