npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

pip-parse

v1.1.1

Published

A pip `requirements.txt` parser

Downloads

617

Readme

pip-parse

pip-parse is a JavaScript library for parsing and interpreting text content typically found in Python package management files, such as requirements.txt. It provides utilities for handling command-line flags and package requirements, supporting both strict and lenient parsing modes.

Features

  • Line Splitting: Handles lines ending with a backslash to support multi-line values.
  • Command-Line Flag Parsing: Recognizes and processes various command-line flags with associated arguments.
  • Requirement Parsing: Parses package requirements, URLs, and paths with optional version constraints.
  • Lenient Parsing: Configurable mode to allow more flexible parsing with less strict validation.

Installation

To use pip-parse, you can include it in your project via require or import statement if you’re working in a Node.js environment.

npm install pip-parse

Usage

parseFile(content, loose = false)

Parses the provided content into an array of parsed data.

Parameters

  • content (string): The content of text to parse.
  • loose (boolean, optional): Whether to allow lenient parsing. Defaults to false. If false, the function will throw errors for unsupported flags, invalid URLs, or malformed requirements.

Returns

  • An array of ParsedData objects representing the parsed content.

Example

const { parseFile } = require('pip-parse');

const content = `
-i https://example.com/simple
mypackage==1.0.0
`;

const parsedData = parseFile(content);
console.log(parsedData);

parseLine(line, loose = false)

Parses a single line of text to determine if it represents a command-line flag or a requirement.

Parameters

  • line (string): The line of text to parse.
  • loose (boolean, optional): Whether to allow lenient parsing. Defaults to false.

Returns

  • An object representing the parsed data, or undefined if the line is a comment.

Example

const { parseLine } = require('pip-parse');

const line = '-i https://example.com/simple';
const parsedLine = parseLine(line);
console.log(parsedLine);

Data Types

CommandLineFlag

  • type (string): Always "CommandLineFlag"
  • flag (string): The flag that was specified.
  • args (string[]): Arguments associated with the flag.

Requirement

  • type (string): Always "Requirement"
  • markers (string|undefined): Optional markers for the requirement.
  • subtype (string): The type of requirement (e.g., "PackageURL", "URL", "Path", "Package").
  • package (string|undefined): The package name, if applicable.
  • extras (string|undefined): Optional extras associated with the package.
  • url (string|undefined): The URL, if applicable.
  • path (string|undefined): The path, if applicable.
  • versions (string[]|undefined): List of version constraints, if applicable.

Supported Options

The following command-line options are supported:

  • -i, --index-url
  • --extra-index-url
  • --no-index
  • -c, --constraint
  • -r, --requirement
  • -e, --editable
  • -f, --find-links
  • --no-binary
  • --only-binary
  • --prefer-binary
  • --require-hashes
  • --pre
  • --trusted-host
  • --use-feature

Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

License

This project is licensed under the MIT License. See the LICENSE file for details.