mirror of https://github.com/juancarlospaco/nim-requirementstxt synced 2026-01-14 01:51:43 +00:00

No description

Find a file

Juan Carlos 769a099b3e update for 1.4		2020-10-04 18:24:52 -03:00
src	update for 1.4	2020-10-04 18:24:52 -03:00
tests	init	2019-11-11 19:31:10 -03:00
.gitignore	Initial commit	2019-11-11 13:33:33 -03:00
LICENSE	Initial commit	2019-11-11 13:33:33 -03:00
README.md	-	2020-07-09 02:15:43 -03:00
requirementstxt.nimble	update for 1.4	2020-10-04 18:24:52 -03:00
temp.png	init	2019-11-11 20:41:05 -03:00

README.md

RequirementsTxt

Python requirements.txt generic iterator parser for Nim.
No Regex used in the making of this film!

Use

for it in requirements(readFile("requirements.txt")):
  echo it

for it in requirements(staticRead("requirements.txt")):
  echo it

for it in requirements(readFile("requirements.txt"), [("*", "0")]):  ## "1.*.*" becomes "1.0.0", uses multiReplace
  echo it

1 Input argument can be filename: string. Based from the official spec: https://pip.readthedocs.io/en/1.1/requirements.html

Output

Yields 1 tuple per parsed line:

line Current line being parsed (42, etc).
editable Boolean whether this requirement is "editable".
specifier String version specifier (For "flask>=1.5" is >=)
vcs Distributed version control system used ("git", "hg", etc).
protocol Network protocol for transports ("http", "https", "ssh", etc)
name Package name parsed ("pytest", etc).
version Package version string ("1.2.9", etc).
uri URL if this requirement of Uri type ("https://github.com/user/repo.git", etc).
extras Sequence of strings with a list of extras ("flask[extra1, extra2]" is @["extra1", "extra2"])
blanks Current count of comments, blank lines, empty lines, etc (42, etc).
private Current count of Private custom repositories (Not PYPI).
nested Current count of recursively Nested requirements.txt files (42, etc).

Example Output:

(line: 9, editable: false, specifier: true, vcs: "git", protocol: "https", version: "1.6.0", name: "numpy", url: "https://github.com/user/repo.git", blanks: 1, nested: 0, private: 0, extras: @["full", "pdf"])

If you need a seq of tuple use sequtils.toSeq. It uses Effects Tags ReadIOEffect, WriteIOEffect.

Install

nimble install requirementstxt

Test

$ nimble test

[Suite] Requirements.txt generic parser tests
  [OK] Big requirements.txt parsing
  [OK] Empty requirements.txt parsing
  [OK] Empty requirements.txt parsing 2
   Success: Execution finished
   Success: All tests passed

Test is using a big and complex requirements.txt.