Skip to main content

Big Five Personality Analysis based on Twitter (X) posts.

Project description

Persai

Persai Logo

Introduction 🔎

Persai 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. 🐦

Diagram

Visit our website for more information and documentation

Installation 🛠️

Install Persai easily using pip:

pip install persai

How to Use 💡

Follow these steps to analyze your Twitter (X) data using Persai:

  1. Export Your Twitter Data:

  2. Prepare Your Data:

    • Locate the twitter.js file in your downloaded Twitter (X) data.
    • Save this file in the directory where you plan to run the Persai package.
  3. Set Your OpenAI Key:

    • 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.
  4. Run Persai:

    • Use the following Python code to perform the Big Five analysis:
     from persai import big_five
    
     openai_key = "your_openai_key_here"
     data = "twitter.js"
     result = big_five(data, openai_key)
     print(result)
    

Sample Output 📈

After running the script, you'll receive a dictionary with the analysis results. It will look something like this:

{
  "openness": "high",
  "conscientiousness": "low",
  "extraversion": "low",
  "agreeableness": "low",
  "neuroticism": "low"
}

These results provide a snapshot of the personality traits expressed in your Twitter (X) posts.

Contributing

Feel free to contribute to the project or suggest improvements! 🌟

Acknowledgments :clap:

This project is a reimplementation of the ideas and methodologies presented in the paper Is ChatGPT a Good Personality Recognizer? A Preliminary Study. Thank you for providing this research.

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

persai-0.0.5.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

persai-0.0.5-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file persai-0.0.5.tar.gz.

File metadata

  • Download URL: persai-0.0.5.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for persai-0.0.5.tar.gz
Algorithm Hash digest
SHA256 6f036037ac837f82dfbdf65d9f9a2ab13f888b979ecb4c1d455eefe16b5213c3
MD5 55f3af6e73eea9c30ffc66757d367fe5
BLAKE2b-256 5c8087872d2065d13753b518fa44ce46e516184b2b58e65d2f8dfc8dd3a17856

See more details on using hashes here.

File details

Details for the file persai-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: persai-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for persai-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6f219b2d88b32cb553c8c6a543c38df855b1f2b47af5fb7ad93529b916a4fa82
MD5 1eb8003bcf2b4e801e65149b3f0c61c0
BLAKE2b-256 dcd2dc52ab40367b1ac27f003290642c1998d698aba44708a2cc1841a6577059

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page