From 201815a5331ea2675529470e87801eb56cb06330 Mon Sep 17 00:00:00 2001 From: yeger Date: Sun, 2 Dec 2018 16:27:38 -0500 Subject: [PATCH] preparing for pypi --- LICENSE | 21 +++++++++++++++++++++ README.md | 14 +++++++++++++- setup.py | 12 ++++++++++-- 3 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0728ddb --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Avi Yeger + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index df83071..5560ca5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ # pylspclient -The library implements a LSP client in Python. +[LSP](https://microsoft.github.io/language-server-protocol/) client implementation in Python. +[![image](https://img.shields.io/pypi/v/pylspclient.svg)](https://pypi.org/project/pylspclient/) [![Build Status](https://travis-ci.org/yeger00/pylspclient.svg?branch=master)](https://travis-ci.org/yeger00/pylspclient) +# Installation +``` +pip install pylspclient +``` + # Run the tests ``` tox ``` + +or + +``` +python setup.py test +``` diff --git a/setup.py b/setup.py index cd47661..3078ca8 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,8 @@ import sys from setuptools import setup, find_packages from setuptools.command.test import test as TestCommand - +with open("README.md", "r") as fh: + long_description = fh.read() class PyTest(TestCommand): user_options = [("pytest-args=", "a", "Arguments to pass to pytest")] @@ -20,7 +21,14 @@ class PyTest(TestCommand): sys.exit(errno) setup( - name="pylspclient", + name="pylspclient", + version="0.0.1", + author="Avi Yeger", + author_email="yeger00@gmail.com", + description="LSP client implementation in Python", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/yeger00/pylspclient", packages=find_packages(), tests_require=["pytest", "pytest_mock"], cmdclass={"test": PyTest},