Skip to content

Commit 3dde667

Browse files
committed
update docs
1 parent 75feb07 commit 3dde667

File tree

2 files changed

+110
-11
lines changed

2 files changed

+110
-11
lines changed

docs/releases/index.rst

Lines changed: 109 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,121 @@ Django Polly follows semantic versioning. This document outlines the changes in
77
.. toctree::
88
:maxdepth: 1
99

10-
0.0.1
11-
0.0.2
12-
0.0.3
13-
0.0.4
1410
0.0.5
11+
0.0.4
12+
0.0.3
13+
0.0.2
14+
0.0.1
1515

16-
0.0.1
16+
0.0.5
17+
-----
18+
19+
*Date: August 12th, 2024*
20+
21+
* Adding images to the documentation
22+
* Update README.rst
23+
* Update version
24+
25+
0.0.4
26+
-----
27+
28+
*Date: August 12th, 2024*
29+
30+
* Publishing workflow to PyPi
31+
* Update topics in setup.py
32+
* Update README.rst
33+
* Update version
34+
35+
0.0.3
1736
-----
1837

19-
Initial release of Django Polly.
38+
*Date: August 12th, 2024*
2039

21-
* Basic LLM integration
22-
* SmartConversations feature
23-
* WebSocket support for real-time chat
24-
* Admin interface for managing Parrots and SmartConversations
40+
* Publishing workflow to PyPi
41+
* Update topics in setup.py
2542

2643
0.0.2
2744
-----
2845

46+
*Date: August 12th, 2024*
47+
48+
* Publishing workflow to PyPi
49+
50+
0.0.1
51+
-----
52+
53+
*Date: August 12th, 2024*
54+
55+
We are excited to announce the initial release of Django Polly!
56+
57+
This version introduces the core functionality for integrating Language Learning Models (LLMs) into Django projects.
58+
59+
Features
60+
^^^^^^^^
61+
62+
* LLM Integration:
63+
* Support for creating and managing LLM instances (Parrots)
64+
* Integration with various LLM backends
65+
* Configurable AI model path
66+
* SmartConversations:
67+
* Framework for AI-powered conversations
68+
* Support for both synchronous and asynchronous communication styles
69+
* WebSocket Support:
70+
* Real-time communication capabilities using Django Channels
71+
* Custom consumers for handling WebSocket connections
72+
* Admin Interface:
73+
* Django admin integration for managing Parrots and SmartConversations
74+
* Custom admin actions for LLM management
75+
* Management Commands:
76+
* `download_model` command for easy LLM model acquisition
77+
* Extensibility:
78+
* Flexible architecture allowing for custom LLM backends
79+
* Easy integration with existing Django projects
80+
81+
Compatibility
82+
^^^^^^^^^^^^^
83+
84+
* Python 3.8+
85+
* Django 4.2 and 5.0
86+
* Channels 3.0+
87+
88+
Installation
89+
^^^^^^^^^^^^
90+
91+
You can install Django Polly 0.0.1 using pip:
92+
93+
.. code-block:: bash
94+
95+
pip install django-polly==0.0.1
96+
97+
Be sure to follow the :doc:`installation guide </installation>` for complete setup instructions.
98+
99+
Upgrade Instructions
100+
^^^^^^^^^^^^^^^^^^^^
101+
102+
As this is the initial release, there are no upgrade instructions. For new installations, please refer to the :doc:`installation guide </installation>`.
103+
104+
Bug Fixes
105+
^^^^^^^^^
106+
107+
As this is the initial release, there are no bug fixes to report.
108+
109+
Known Issues
110+
^^^^^^^^^^^^
111+
112+
* Performance with very large LLM models may be suboptimal. We recommend using smaller, more efficient models for best results.
113+
* WebSocket connections may require additional configuration in certain deployment environments.
114+
115+
Please report any issues you encounter on our `GitHub issue tracker <https://github.com/pollystack/django-polly/issues>`_.
116+
117+
What's Next
118+
^^^^^^^^^^^
119+
120+
We are actively working on improving Django Polly. Future releases will focus on:
121+
122+
* Performance optimizations for LLM interactions
123+
* Expanded LLM backend support
124+
* Enhanced documentation and tutorials
125+
* Improved error handling and debugging tools
126+
127+
Thank you for using Django Polly! We look forward to your feedback and contributions.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name='django-polly',
5-
version='0.0.4',
5+
version='0.0.5',
66
packages=find_packages(exclude=['tests*']),
77
package_data={
88
'django_polly': ['templates/**/*.html', 'static/**/*'],

0 commit comments

Comments
 (0)