Skip to content

Commit ff57b75

Browse files
committed
Update README and remove TODO.
1 parent d395a83 commit ff57b75

File tree

2 files changed

+38
-25
lines changed

2 files changed

+38
-25
lines changed

README.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ things, with as minimal dependencies as possible:
99

1010
# Usage
1111

12-
Example snippet to show how to get the metadata from a wheel.
12+
Example snippet to show how to get the metadata from a wheel.
1313

1414
```python
1515
from zipfile import ZipFile
@@ -24,32 +24,47 @@ print(basic_metadata_from_wheel(zf, "somepkg"))
2424
```
2525
BasicMetadata(
2626
reqs=[
27-
'build',
28-
'setuptools',
29-
'pip',
30-
'imperfect<1',
31-
'tomlkit<1',
32-
'click~=8.0',
33-
'GitPython~=3.1.18',
34-
'metatron==0.60.0',
35-
'pkginfo~=1.9',
36-
'pyyaml~=6.0',
37-
'runez~=5.2',
38-
'pathspec<1',
39-
'virtualenv<20.21',
40-
'tox~=3.28',
41-
'requests~=2.27',
42-
'urllib3~=1.26'
27+
'cli-helpers[styles] >=2.2.1',
28+
'click >=4.1',
29+
'configobj >=5.0.5',
30+
'prompt-toolkit <4.0.0,>=3.0.3',
31+
'pygments >=1.6',
32+
'sqlparse >=0.4.4',
33+
"behave >=1.2.6 ; extra == 'dev'",
34+
"coverage >=7.2.7 ; extra == 'dev'",
35+
"pexpect >=4.9.0 ; extra == 'dev'",
36+
"pytest >=7.4.4 ; extra == 'dev'",
37+
"pytest-cov >=4.1.0 ; extra == 'dev'",
38+
"tox >=4.8.0 ; extra == 'dev'",
39+
"pdbpp >=0.10.3 ; extra == 'dev'"
4340
],
44-
provides_extra=frozenset(),
45-
name='pynt',
46-
requires_python='>=3.6',
47-
url='https://stash.corp.netflix.com/projects/NFPY/repos/pynt/browse',
48-
project_urls={}
41+
provides_extra=frozenset({'dev'}),
42+
name='litecli',
43+
version='1.12.4',
44+
requires_python='>=3.7',
45+
url=None,
46+
project_urls={'homepage, https://github.com/dbcli/litecli': ''},
47+
author=None,
48+
author_email='dbcli <[email protected]>',
49+
summary='CLI for SQLite Databases with auto-completion and syntax highlighting.',
50+
description='# litecli\n\n[![GitHub
51+
Actions](https://github.com/dbcli/litecli/actions/workflows/ci.yml/badge.svg)](https://github.com/dbcli/litecli/actions/workflows/ci.yml "GitHub
52+
Actions")\n\n[Docs](https://litecli.com)\n\nA command-line client for SQLite databases that has auto-completion and syntax
53+
highlighting.\n\n![Completion](screenshots/litecli.png)\n![CompletionGif](screenshots/litecli.gif)\n\n## Installation\n\nIf you already know how to install python
54+
packages, then you can install it via pip:\n\nYou might need sudo on linux.\n\n```\n$ pip install -U litecli\n```\n\nThe package is also available on Arch Linux through
55+
AUR in two versions: [litecli](https://aur.archlinux.org/packages/litecli/) is based the latest release (git tag) and
56+
[litecli-git](https://aur.archlinux.org/packages/litecli-git/) is based on the master branch of the git repo. You can install them manually or with an AUR helper such as
57+
`yay`:\n\n```\n$ yay -S litecli\n```\n\nor\n\n```\n$ yay -S litecli-git\n```\n\nFor MacOS users, you can also use Homebrew to install it:\n\n```\n$ brew install
58+
litecli\n```\n\n## Usage\n\n```\n$ litecli --help\n\nUsage: litecli [OPTIONS] [DATABASE]\n\nExamples:\n - litecli sqlite_db_name\n```\n\nA config file is automatically
59+
created at `~/.config/litecli/config` at first launch. For Windows machines a config file is created at `~\\AppData\\Local\\dbcli\\litecli\\config` at first launch. See
60+
the file itself for a description of all available options.\n\n## Docs\n\nVisit: [litecli.com/features](https://litecli.com/features)\n',
61+
keywords=None,
62+
long_description_content_type='text/markdown'
4963
)
64+
5065
```
5166

52-
The metadata can be extracted from a `wheel`, `sdist` (zip or tarball). Check [`__init__.py`](metadata_please/__init__.py) file for all available functions.
67+
The metadata can be extracted from a `wheel`, `sdist` (zip or tarball) or a source checkout (best effort). Check [`__init__.py`](metadata_please/__init__.py) file for all available functions.
5368

5469
# Version Compat
5570

metadata_please/source_checkout.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -367,8 +367,6 @@ def from_setup_cfg_checkout(path: Path) -> bytes:
367367
"Requires-Dist: " + merge_extra_marker(extra_name, i) + "\n"
368368
)
369369

370-
# TODO name requires_python url project_urls
371-
372370
return "".join(buf).encode("utf-8")
373371

374372

0 commit comments

Comments
 (0)