mirrors/LibCST
1
0
Fork 0
mirror of https://github.com/Instagram/LibCST.git synced 2025-12-23 10:35:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A concrete syntax tree parser and serializer library for Python that preserves many aspects of Python's abstract syntax tree https://libcst.readthedocs.io/
12 commits 100 branches 53 tags 8.7 MiB
Find a file
Benjamin Woodruff c5f24f35a4 Improve the way dependencies are declared 
@jreese had some suggestions in my previous pull request after it got
merged, so this addresses some of those suggestions:

- Uses the PEP 508 `python_version` environment marker instead of
  conditional logic inside `setup.py`. I've updated `requirements.txt`
  to use this too.
- Split dev requirements into a separate `requirements-dev.txt`, and
  updated the README to include instructions for it.

This PR does not use pyup, because it looks like it's free for
non-commercial use only (I don't know that that means in this context),
and because this project isn't public yet.

It also does not include a makefile yet, because Jennifer and I need to
talk through where we'd stick the virtualenv in that case.

I tested these changes on 3.6 and 3.7.
2019-07-22 19:53:49 -07:00
libcst Improve setup.py compatibility 2019-06-06 15:37:27 -07:00
stubs Initial export of LibCST to github. 2019-05-31 14:16:53 -07:00
.gitignore Improve setup.py compatibility 2019-06-06 15:37:27 -07:00
LICENSE first commit 2019-05-29 11:32:49 -07:00
README.md Improve the way dependencies are declared 2019-07-22 19:53:49 -07:00
requirements-dev.txt Improve the way dependencies are declared 2019-07-22 19:53:49 -07:00
requirements.txt Improve the way dependencies are declared 2019-07-22 19:53:49 -07:00
setup.py Improve the way dependencies are declared 2019-07-22 19:53:49 -07:00

README.md

LibCST

TODO: Add documentation.

Getting Started

Examining a sample tree

To examine the tree that is parsed from a particular file, do the following:

python -m libcst.tool print <some_py_file.py>

Development

Start by setting up and activating a virtualenv:

git clone git@github.com:Instagram/LibCST.git libcst
cd libcst
python3 -m venv ../libcst-env/  # just an example, put this wherever you want
source ../libcst-env/bin/activate
pip install --upgrade pip  # optional, if you have an old system version of pip
pip install -r requirements.txt -r requirements-dev.txt
# If you're done with the virtualenv, you can leave it by running:
deactivate

Auto-formatting code with isort and Black

We use isort and black to format code. To format changes to be conformant, run the following in the root:

isort -q -w 88 -m 3 -tc -fgw 0 -lai 2 -ca -ns __init__.py -y && black --target-version py36 libcst/

Running tests

To run all tests, do the following in the root:

find -name "test_*.py" -printf '%P\n' | xargs python3 -m unittest

Verifying types with Pyre

To verify types for the library, do the following in the root:

pyre --source-directory . --search-path stubs/ check