Skip to main content

Code for identifying Marx quotes associated with the CDH project Citing Marx

Project description

remarx

This repository contains in-progress research software developed for the CDH project Citing Marx. The primary purpose of this software is to identify quotes of Karl Marx's Manifest der Kommunistischen Partei and the first volume of Das Kapital within articles published in Die Neue Zeit between 1891 and 1918.

Unit Tests

Basic Usage

Installation

Documentation assumes the use of uv for installing python and python packages, as well as running python scripts. The first time you follow these instructions, you should install uv per uv installation documentation. This only step only needs to be done once.

Create a uv environment

Create a new virtual environment using uv.

uv venv --python 3.12

Install remarx

remarx as a python package directly from GitHub. Use a branch or tag name, e.g. @develop or @0.1 if you need to install a specific version.

uv pip install "remarx @ git+https://github.com/Princeton-CDH/remarx"

Launch quote finder app

To launch the remarx quote finder application run the remarx-app command:

uv run remarx-app

Closing quote finder app

The app will not close automatically when you close the browser window or tab. To close the app:

  1. Type control+c within the terminal where the remarx-app command was run
  2. Then, when prompted, type y followed by enter.

Documentation

Find public documentation at: remarx Documentation

Development

For development setup, documentation generation, and contributing guidelines, see Developer Notes.

License

This project is licensed under the Apache 2.0 License.

(c)2025 Trustees of Princeton University. Permission granted for non-commercial distribution online under a standard Open Source 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

remarx-0.2.tar.gz (185.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

remarx-0.2-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file remarx-0.2.tar.gz.

File metadata

  • Download URL: remarx-0.2.tar.gz
  • Upload date:
  • Size: 185.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for remarx-0.2.tar.gz
Algorithm Hash digest
SHA256 4d1a5041df26886dd2179171dbbd6eff247158da5762a0f479f7701dd8c3fc87
MD5 1a9f52e66363245ce68c277e41a175d6
BLAKE2b-256 ab9669c96c342b917a575c7b3e6393d58ef14b1d8a5a74efd832a40d04437b4f

See more details on using hashes here.

Provenance

The following attestation bundles were made for remarx-0.2.tar.gz:

Publisher: python-publish.yml on Princeton-CDH/remarx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file remarx-0.2-py3-none-any.whl.

File metadata

  • Download URL: remarx-0.2-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for remarx-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c2f22047d20b94fc35619d9b9ed83ee4f71e7058344d1d17032ed1c03da37e1a
MD5 c3734165014628b02997429834535c8a
BLAKE2b-256 e2a012693ff0d4d4224d0aed3393f3fcf4ef0e51810dd2e7e2065db97c5dd071

See more details on using hashes here.

Provenance

The following attestation bundles were made for remarx-0.2-py3-none-any.whl:

Publisher: python-publish.yml on Princeton-CDH/remarx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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