This release is a pre-release and may not be stable for production use.
Psychological Construct Definition Retrieval
Psychological Construct Definition Retrieval is a Python package for retrieving evidence-based definitions of psychological constructs from PubMed and PubMed Central (PMC) literature.
Overview
The package implements a literature retrieval workflow that searches the biomedical literature for a target psychological construct, retrieves relevant PubMed abstracts and PubMed Central (PMC) full-text articles, identifies candidate definition statements, ranks evidence using semantic similarity, and selects the strongest explicit definition found in the retrieved literature.
The APA Dictionary of Psychology is used only to verify and reference existing dictionary entries. APA content is not used to identify definitions from the scientific literature.
Workflow
Features
- Search PubMed for articles related to a psychological construct.
- Retrieve full-text articles from PubMed Central (PMC), when available.
- Retrieve PubMed abstracts and examine them alongside available full-text articles.
- Extract candidate definition and conceptual passages from PMC full text and PubMed abstracts.
- Chunk and prepare retrieved evidence for semantic retrieval.
- Perform semantic retrieval using sentence-transformer embeddings.
- Rank evidence passages by cosine similarity to the construct-focused definitional query.
- Select the strongest explicit definition found in the retrieved literature.
- Verify APA Dictionary entries and provide the official reference URL when available.
- Export the definition from literature and supporting evidence as Markdown.
Installation
pip install psych-defgen
playwright install chromium
Verify Installation
python -c "import psych_defgen; print('Package installed successfully')"
Development Installation
To install development version from GitHub:
git clone https://github.com/uflcod/psych-defgen.git
cd psych-defgen
pip install -e .
playwright install chromium
Editable installation allows you to make changes to the source code and use them immediately without reinstalling the package.
Configure NCBI Credentials
This package uses the NCBI Entrez API to retrieve PubMed and PubMed Central articles.
Create a .env file in the root of the project directory:
.env
Add your NCBI email address and optional NCBI API key:
NCBI_EMAIL=YOUR_NCBI_EMAIL
NCBI_API_KEY=YOUR_NCBI_API_KEY
Replace YOUR_NCBI_EMAIL with your email address and YOUR_NCBI_API_KEY with your NCBI API key.
The NCBI email address is required. The NCBI API key is optional but recommended for higher request rate limits.
The package does not store or transmit your email address or API key except when making requests to the official NCBI Entrez API. These credentials are used only to identify your requests in accordance with NCBI API guidelines.
Do not commit the .env file to the repository.
Usage
Retrieve a definition for a psychological construct:
psych-defgen gerotranscendence
Multi-word constructs are supported:
psych-defgen "social isolation"
Specify the number of retrieved articles and evidence passages:
psych-defgen "social isolation" \
--max-results 20 \
--top-k 5
Specify a custom output file:
psych-defgen "social isolation" \
--output results/social_isolation_definition.md
Display all available command-line options:
psych-defgen --help
Output
By default, retrieved definitions and supporting evidence are saved as Markdown files in the outputs directory. A custom output file can be specified using the --output option.
outputs/social_isolation_definition.md
The output filename is automatically created from the requested psychological construct.
Requirements
- Python 3.11+
- Valid NCBI email address
- Chromium browser installed through Playwright
Install the required Playwright browser with
playwright install chromium
An NCBI API key is optional but recommended for higher request rate limits.
License
This project is licensed under the MIT License.
Citation
Citation information will be provided upon publication of the accompanying manuscript.
Release files for psych-defgen 0.0.1a2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| psych_defgen-0.0.1a2.tar.gz | 17.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| psych_defgen-0.0.1a2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.4 kB
Release files / psych_defgen-0.0.1a2.tar.gz
| Download URL | psych_defgen-0.0.1a2.tar.gz |
|---|---|
| Size | 17.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e00c12f68e2e8a95c9dec98f6d6e376061c8edd59b719dfd3f44458247857fba
|
|
BLAKE2b-256 checksum How to use checksums |
9b64eb56d4c791f67f40bbd5c36dc9e514a6c24f6adca6af11f6481d291674f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / psych_defgen-0.0.1a2-py3-none-any.whl
| Download URL | psych_defgen-0.0.1a2-py3-none-any.whl |
|---|---|
| Size | 22.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4a3faf444f55e192c897ddf4ce6c16415a3cb6b7d404f23c4945c9fff30e1604
|
|
BLAKE2b-256 checksum How to use checksums |
4043c1c607bd97e6c028df08b7c633d889fe08704f4782b7f62670e10673ebc2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|