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

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.1.0.tar.gz (94.0 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.1.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for remarx-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d8264a5821f3d4356da5ff1243db7f78a41a8cbffb2428ce43851a43ef56f5d5
MD5 db2d063a8eff4b132178caa978d9f1cd
BLAKE2b-256 55a0f125bafe893ee588864c9d7033e96823b96cb7cbd07f7405928327f051d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for remarx-0.1.0.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: remarx-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.1 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91f2c3b0c5efd20522d04b5d87c51cc5a27caade888353928dcf6251decf7ee7
MD5 13cf97b92466bed1c1d7de6b112356e0
BLAKE2b-256 96f9b8b6c2a23b4f04696e9d72614fb7acb55c344046063b83fd3f0cdee96a31

See more details on using hashes here.

Provenance

The following attestation bundles were made for remarx-0.1.0-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