Metadata-Version: 2.4
Name: adsfolio
Version: 0.8.0
Summary: Research PDF management with ADS, Crossref, DataCite, and local references
Author-email: "Yoonsoo P. Bach" <ysbach20766@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/ysBach/adsfolio
Project-URL: Documentation, https://ysbach.github.io/adsfolio/docs/
Project-URL: Repository, https://github.com/ysBach/adsfolio
Project-URL: Issues, https://github.com/ysBach/adsfolio/issues
Keywords: ads,scixplorer,astronomy,astrophysics,heliophysics,physics,life-sciences,space-biology,microgravity,materials-science,earth-science,atmospheric-science,oceanography,planetary-science,bibliography,scientific-literature
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Oceanography
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28
Requires-Dist: click>=8.0
Requires-Dist: platformdirs>=3.0
Requires-Dist: tqdm>=4.66
Requires-Dist: pypdf>=4.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: bibtexparser<2,>=1.4.3
Requires-Dist: pyparsing>=3.0
Provides-Extra: full
Requires-Dist: pymupdf>=1.24; extra == "full"
Requires-Dist: watchdog>=3.0; extra == "full"
Requires-Dist: iso4>=0.0.2; extra == "full"
Provides-Extra: gui
Requires-Dist: PySide6>=6.6; extra == "gui"
Requires-Dist: packaging>=23.2; extra == "gui"
Dynamic: license-file

# ADSfolio

A desktop app and Python toolkit that organizes your research PDFs with NASA
ADS / SciXplorer, Crossref, and DataCite metadata. ADSfolio is an independent
project, not an official ADS application.

![ADSfolio library window with illustrative sample data](https://raw.githubusercontent.com/ysBach/adsfolio/main/docs/_static/app-overview.png)

## Install

- **Desktop app:** download the file for your system from the
  [latest release](https://github.com/ysBach/adsfolio/releases/latest).
- **Homebrew on macOS:** `brew install --cask ysBach/adsfolio/adsfolio`
- **CLI and Python:** `pip install adsfolio`, or
  `pip install "adsfolio[full,gui]"` for the desktop app too.

The app is not signed. Your system can ask you to approve it the first time.
See [Getting started](https://ysbach.github.io/adsfolio/docs/getting-started.html#install)
for the steps.

## Daily workflows

- **Keep a BibTeX file for your paper:** export an ADS library as `.bib` for
  LaTeX or Overleaf.
- **Watch a folder:** ADSfolio identifies each new PDF and renames it when the
  PDF's own arXiv ID or DOI confirms the match.
- **Keep Identify defaults:** save ADS fallback and provider choices for all
  libraries or one library.
- **Make your CV:** write your publication list in LaTeX, HTML, Markdown, or
  your own format.

See the [daily workflows](https://ysbach.github.io/adsfolio/docs/workflows.html)
with screenshots and a video.

## Documentation

- [Website](https://ysbach.github.io/adsfolio/)
- [Getting started](https://ysbach.github.io/adsfolio/docs/getting-started.html)
- [App GUI guide](https://ysbach.github.io/adsfolio/docs/gui.html)
- [CLI and Python](https://ysbach.github.io/adsfolio/docs/command-line-and-python.html)
  and the [API reference](https://ysbach.github.io/adsfolio/docs/api/index.html)
- [Changelog](https://github.com/ysBach/adsfolio/blob/main/CHANGELOG.md) and
  [issues](https://github.com/ysBach/adsfolio/issues)

## License

BSD-3-Clause. The desktop bundles include third-party components under their
own licenses. PyMuPDF uses AGPL terms. See
[Building the desktop app](https://ysbach.github.io/adsfolio/docs/desktop.html)
for details.
