edsl 0.1.39.dev3__tar.gz → 0.1.39.dev5__tar.gz

{edsl-0.1.39.dev3 → edsl-0.1.39.dev5}/LICENSE

@@ -1,21 +1,21 @@
-The MIT License
-
-Copyright (c) Apostolos Filippas, John Joseph Horton, Roberta Horton.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License
+
+Copyright (c) Apostolos Filippas, John Joseph Horton, Roberta Horton.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

{edsl-0.1.39.dev3 → edsl-0.1.39.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edsl
-Version: 0.1.39.dev3
+Version: 0.1.39.dev5
 Summary: Create and analyze LLM-based surveys
 Home-page: https://www.expectedparrot.com/
 License: MIT
@@ -34,12 +34,15 @@ Requires-Dist: numpy (>=1.22,<2.0)
 Requires-Dist: openai (>=1.4.0,<2.0.0)
 Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
 Requires-Dist: pandas (>=2.1.4,<3.0.0)
+Requires-Dist: platformdirs (>=4.3.6,<5.0.0)
 Requires-Dist: pydot (>=2.0.0,<3.0.0)
 Requires-Dist: pygments (>=2.17.2,<3.0.0)
 Requires-Dist: pymupdf (>=1.24.4,<2.0.0)
+Requires-Dist: pypdf2 (>=3.0.1,<4.0.0)
 Requires-Dist: pyreadstat (>=1.2.7,<2.0.0)
 Requires-Dist: python-docx (>=1.1.0,<2.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: python-pptx (>=1.0.2,<2.0.0)
 Requires-Dist: restrictedpython (>=7.1,<8.0)
 Requires-Dist: rich (>=13.7.0,<14.0.0)
 Requires-Dist: setuptools (<72.0)
@@ -84,26 +87,25 @@ q = QuestionMultipleChoice(
 # Run it with the default language model
 results = q.run()
 
-# Inspect the results in a dataset
-results.select("example_question").print()
+# Inspect the results 
+results.select("example_question")
 ```
 
 Output:
 ```python
-┏━━━━━━━━━━━━━━━━━━━┓
-┃ answer            ┃
-┃ .example_question ┃
-┡━━━━━━━━━━━━━━━━━━━┩
-│ Good              │
-└───────────────────┘
+┏━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ answer.example_question ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ Good                    │
+└─────────────────────────┘
 ```
 
 ## 💻 Requirements
 * EDSL is compatible with Python 3.9 - 3.12.
 * API keys for large language models that you want to use, stored in a `.env` file.
-See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
+See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html) and [activating remote inference](https://docs.expectedparrot.com/en/latest/remote_inference.html).
 
 ## 💡 Contributions, feature requests & bugs
 Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
-Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m).
+Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m)..
 

{edsl-0.1.39.dev3 → edsl-0.1.39.dev5}/README.md

@@ -1,55 +1,54 @@
-# Expected Parrot Domain-Specific Language 
-<p align="center">
-  <img src="https://github.com/expectedparrot/edsl/blob/main/static/logo.png?raw=true" alt="edsl.png" width="100"/>
-</p>
-
-The Expected Parrot Domain-Specific Language (EDSL) package lets you conduct computational social science and market research with AI. Use it to design surveys and experiments, simulate responses with large language models, and perform data labeling and other research tasks. Results are formatted as specified datasets and come with built-in methods for analyzing, visualizing, and sharing. 
-
-## 🔗 Links
-- [PyPI](https://pypi.org/project/edsl/)
-- [Documentation](https://docs.expectedparrot.com)
-- [Getting started](https://docs.expectedparrot.com/en/latest/starter_tutorial.html) 
-- [Discord](https://discord.com/invite/mxAYkjfy9m)
-- [Twitter](https://x.com/ExpectedParrot)
-- [LinkedIn](https://www.linkedin.com/company/expectedparrot/)
-- [Blog](https://blog.expectedparrot.com)
-
-## 🌎 Hello, World!
-A quick example:
-
-```python
-# Import a question type
-from edsl import QuestionMultipleChoice
-
-# Construct a question using the question type template
-q = QuestionMultipleChoice(
-    question_name="example_question",
-    question_text="How do you feel today?",
-    question_options=["Bad", "OK", "Good"]
-)
-
-# Run it with the default language model
-results = q.run()
-
-# Inspect the results in a dataset
-results.select("example_question").print()
-```
-
-Output:
-```python
-┏━━━━━━━━━━━━━━━━━━━┓
-┃ answer            ┃
-┃ .example_question ┃
-┡━━━━━━━━━━━━━━━━━━━┩
-│ Good              │
-└───────────────────┘
-```
-
-## 💻 Requirements
-* EDSL is compatible with Python 3.9 - 3.12.
-* API keys for large language models that you want to use, stored in a `.env` file.
-See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
-
-## 💡 Contributions, feature requests & bugs
-Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
-Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m).
+# Expected Parrot Domain-Specific Language 
+<p align="center">
+  <img src="https://github.com/expectedparrot/edsl/blob/main/static/logo.png?raw=true" alt="edsl.png" width="100"/>
+</p>
+
+The Expected Parrot Domain-Specific Language (EDSL) package lets you conduct computational social science and market research with AI. Use it to design surveys and experiments, simulate responses with large language models, and perform data labeling and other research tasks. Results are formatted as specified datasets and come with built-in methods for analyzing, visualizing, and sharing. 
+
+## 🔗 Links
+- [PyPI](https://pypi.org/project/edsl/)
+- [Documentation](https://docs.expectedparrot.com)
+- [Getting started](https://docs.expectedparrot.com/en/latest/starter_tutorial.html) 
+- [Discord](https://discord.com/invite/mxAYkjfy9m)
+- [Twitter](https://x.com/ExpectedParrot)
+- [LinkedIn](https://www.linkedin.com/company/expectedparrot/)
+- [Blog](https://blog.expectedparrot.com)
+
+## 🌎 Hello, World!
+A quick example:
+
+```python
+# Import a question type
+from edsl import QuestionMultipleChoice
+
+# Construct a question using the question type template
+q = QuestionMultipleChoice(
+    question_name="example_question",
+    question_text="How do you feel today?",
+    question_options=["Bad", "OK", "Good"]
+)
+
+# Run it with the default language model
+results = q.run()
+
+# Inspect the results 
+results.select("example_question")
+```
+
+Output:
+```python
+┏━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ answer.example_question ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ Good                    │
+└─────────────────────────┘
+```
+
+## 💻 Requirements
+* EDSL is compatible with Python 3.9 - 3.12.
+* API keys for large language models that you want to use, stored in a `.env` file.
+See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html) and [activating remote inference](https://docs.expectedparrot.com/en/latest/remote_inference.html).
+
+## 💡 Contributions, feature requests & bugs
+Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
+Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m)..