Skip to content

Commit 43d7bae

Browse files
authored
Prepare for a dev release to PyPI (#140)
1 parent 7e08d51 commit 43d7bae

File tree

6 files changed

+111
-34
lines changed

6 files changed

+111
-34
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,5 @@ ENV/
6161

6262
# Misc
6363
TODO
64+
lintout.txt
6465
.idea/

Pipfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ mypy = "*"
99
prospector = "*"
1010
pytest = "*"
1111
pytest-cov = "*"
12+
twine = "*"
1213
yapf = "*"
1314

1415
[packages]

Pipfile.lock

Lines changed: 57 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,35 @@
11
# 🐍 basilisp 🐍
22

3-
A Lisp dialect inspired by Clojure targeting Python.
3+
A Lisp dialect inspired by Clojure targeting Python 3.
44

5-
![CircleCI](https://img.shields.io/circleci/project/github/chrisrink10/basilisp.svg?style=flat-square) ![Coveralls github](https://img.shields.io/coveralls/github/chrisrink10/basilisp.svg?style=flat-square)
5+
**Disclaimer:** _Basilisp is a project I created to learn about Python, Clojure,
6+
and hosted languages generally. It should not be used in a production setting._
67

7-
## Requirements
8+
![PyPI](https://img.shields.io/pypi/v/basilisp.svg?style=flat-square) ![python](https://img.shields.io/pypi/pyversions/basilisp.svg?style=flat-square) ![CircleCI](https://img.shields.io/circleci/project/github/chrisrink10/basilisp.svg?style=flat-square) ![Coveralls github](https://img.shields.io/coveralls/github/chrisrink10/basilisp.svg?style=flat-square) ![license](https://img.shields.io/github/license/chrisrink10/basilisp.svg?style=flat-square)
9+
10+
## Getting Started
11+
12+
Basilisp is developed on [GitHub](https://github.com/chrisrink10/basilisp)
13+
and hosted on [PyPI](https://pypi.python.org/pypi/basilisp). You can
14+
fetch Basilisp using a simple:
15+
16+
```bash
17+
pip install basilisp
18+
```
19+
20+
Once Basilisp is installed, you can enter into the REPL using:
21+
22+
```bash
23+
python -m basilisp.main
24+
```
25+
26+
Basilisp features many of the same functions and idioms as [Clojure](https://clojure.org/)
27+
so you may find guides and documentation there helpful for getting
28+
started.
29+
30+
## Developing on Basilisp
31+
32+
### Requirements
833

934
This project uses [`pipenv`](https://github.com/kennethreitz/pipenv) to
1035
manage the Python virtual environment and project dependencies. `pipenv`
@@ -23,7 +48,23 @@ manage versions of Python readily on your local development environment.
2348
Setup of `pyenv` is somewhat more specific to your environment, so see
2449
the documentation in the repository for more information.
2550

26-
## Testing
51+
### Performing Type Checking and Linting
52+
53+
Perform type checking with [MyPy](http://mypy-lang.org/) using:
54+
55+
```bash
56+
make typecheck
57+
```
58+
59+
Perform linting with [Prospector](https://prospector.landscape.io/en/master/):
60+
61+
```bash
62+
make lint
63+
```
64+
65+
The linting artifact will be emitted at the project root as `lintout.txt`.
66+
67+
### Running Tests
2768

2869
Tests can be run using the following command:
2970

basilisp/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
VERSION = (0, 1, 0)
1+
VERSION = (0, 1, "dev0")
22

33
__version__ = '.'.join(map(str, VERSION))

setup.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
'atomos',
2626
'pyfunctional',
2727
'pyrsistent',
28-
'pytest'
28+
'pytest',
29+
'python-dateutil'
2930
]
3031

3132
EXTRAS = {}
@@ -110,12 +111,15 @@ def run(self):
110111
classifiers=[
111112
# Trove classifiers
112113
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
114+
'Development Status :: 3 - Alpha',
115+
'Intended Audience :: Developers',
113116
'License :: OSI Approved :: MIT License',
114117
'Programming Language :: Python',
115118
'Programming Language :: Python :: 3',
116119
'Programming Language :: Python :: 3.6',
117120
'Programming Language :: Python :: Implementation :: CPython',
118-
'Programming Language :: Python :: Implementation :: PyPy'
121+
'Programming Language :: Python :: Implementation :: PyPy',
122+
'Topic :: Software Development :: Compilers'
119123
],
120124
# $ setup.py publish support.
121125
cmdclass={

0 commit comments

Comments
 (0)