Skip to main content

List of files that indicate a project root

Project description

> project-markers

Common project root markers.

It's just a JSON file, so you can use it in any environment.

Installation

pip install project-markers

Usage

import project_markers

print(project_markers)
# => ['.ansible-lint', '.bazelrc', '.browserslistrc', '.buckconfig', ...]

Note: Most type checkers will falsely warn project_markers is not iterable because they are incapable of analyzing runtime behavior (where the module is replaced w/ a list for cleaner, direct access). You can safely suppress such warnings using # type: ignore.

The list includes hundreds of markers from many tools and ecosystems, including:

  • Version control (.git, .hg, .svn)
  • Python (pyproject.toml, setup.py, requirements.txt)
  • JavaScript (package.json, yarn.lock, tsconfig.json)
  • Docker/K8s (Dockerfile, docker-compose.yml)
  • CI/CD (.github, .gitlab-ci.yml, Jenkinsfile)

MIT License

Copyright © 2026 Adam Lui

Related

📂 find-project-root - Locate project root via custom markers.
📊 get-min-py - Get the minimum Python version required for a PyPI package.

More Python utilities

Download files

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

Source Distribution

project_markers-1.0.2.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

project_markers-1.0.2-py2.py3-none-any.whl (6.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file project_markers-1.0.2.tar.gz.

File metadata

  • Download URL: project_markers-1.0.2.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for project_markers-1.0.2.tar.gz
Algorithm Hash digest
SHA256 bbb5819009276d50f6d74ed1916ffdb3083df6c8f99447fc6252a5baffeca794
MD5 f552890baf61a74a1e5518074d5345ca
BLAKE2b-256 f665ca70f756b1d1bcfeb6e233d1626eb3c28351eb48ea7c3bb7a8ab2e165c82

See more details on using hashes here.

File details

Details for the file project_markers-1.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for project_markers-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 39c1cd97d4fb9a33d67106d7a33aa8b75086b6483f2d7e08686d69b88208b483
MD5 5247a27e7e89197657c27862ec6ef501
BLAKE2b-256 0ea6f670b046c25787d5645d382d34bb02b8cbb0be3d0825d3066e8e90830064

See more details on using hashes here.

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