{"id":26728416,"url":"https://github.com/yachty66/persai","last_synced_at":"2025-10-06T00:02:22.409Z","repository":{"id":214743059,"uuid":"737230624","full_name":"yachty66/persai","owner":"yachty66","description":"Big Five Personality Analysis based on Twitter (X) posts.","archived":false,"fork":false,"pushed_at":"2024-05-12T10:50:14.000Z","size":472,"stargazers_count":4,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-14T09:20:02.146Z","etag":null,"topics":["ai","big-five","gpt-4","openai","personality-predicting","python"],"latest_commit_sha":null,"homepage":"https://www.persai.org/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yachty66.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-12-30T09:15:06.000Z","updated_at":"2025-03-29T21:20:12.000Z","dependencies_parsed_at":"2023-12-30T12:26:27.977Z","dependency_job_id":"51d85f57-2c35-4bd3-b4a6-73ab27ed98cc","html_url":"https://github.com/yachty66/persai","commit_stats":null,"previous_names":["yachty66/persai"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yachty66%2Fpersai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yachty66%2Fpersai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yachty66%2Fpersai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yachty66%2Fpersai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yachty66","download_url":"https://codeload.github.com/yachty66/persai/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852186,"owners_count":21171843,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","big-five","gpt-4","openai","personality-predicting","python"],"created_at":"2025-03-27T22:35:20.163Z","updated_at":"2025-10-06T00:02:17.353Z","avatar_url":"https://github.com/yachty66.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Persai\n\n![Persai Logo](images/logo.png)\n\n## Introduction 🔎\n\nPersai is a Python package designed to analyze Twitter (X) posts and provide insights into the Big Five personality traits (Openness, Conscientiousness, Extraversion, Agreeableness, Neuroticism). This tool leverages data from your Twitter archive to offer a unique perspective on your social media presence. 🐦\n\n![Diagram](images/diagram.png)\n\n[Visit our website for more information and documentation](https://www.persai.org/)\n\n## Installation 🛠️\n\nInstall Persai easily using pip:\n\n```bash\npip install persai\n```\n\n## How to Use 💡\n\nFollow these steps to analyze your Twitter (X) data using Persai:\n\n1. **Export Your Twitter Data**:\n   - Follow Twitter's guidelines to [download your Twitter (X) archive](https://help.twitter.com/en/managing-your-account/how-to-download-your-twitter-archive).\n\n2. **Prepare Your Data**:\n   - Locate the `twitter.js` file in your downloaded Twitter (X) data.\n   - Save this file in the directory where you plan to run the Persai package.\n\n3. **Set Your OpenAI Key**:\n   - Assign your OpenAI key to a variable. For security reasons, avoid hardcoding the key in your script. Instead, consider using environment variables or other secure methods.\n\n3. **Run Persai**:\n   - Use the following Python code to perform the Big Five analysis:\n\n   ```python\n    from persai import big_five\n\n    openai_key = \"your_openai_key_here\"\n    data = \"twitter.js\"\n    result = big_five(data, openai_key)\n    print(result)\n   ```\n\n## Sample Output 📈\n\nAfter running the script, you'll receive a dictionary with the analysis results. It will look something like this:\n\n```json\n{\n  \"openness\": \"high\",\n  \"conscientiousness\": \"low\",\n  \"extraversion\": \"low\",\n  \"agreeableness\": \"low\",\n  \"neuroticism\": \"low\"\n}\n```\n\nThese results provide a snapshot of the personality traits expressed in your Twitter (X) posts.\n\n## Contributing\n\nFeel free to contribute to the project or suggest improvements! 🌟\n\n## Acknowledgments :clap:\n\nThis project is a reimplementation of the ideas and methodologies presented in the paper [Is ChatGPT a Good Personality Recognizer? A Preliminary Study](https://arxiv.org/pdf/2307.03952.pdf). Thank you for providing this research.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyachty66%2Fpersai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyachty66%2Fpersai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyachty66%2Fpersai/lists"}