Add basic project structure

AlexAltea · AlexAltea · commit c828ac63f9aa · 2021-03-12T16:02:30.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,10 @@
+# EditorConfig
+# http://editorconfig.org
+
+root = true
+
+[**.{py}]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,12 @@
+# PyCharm
+.idea
+
+# Python
+*.pyc
+*.pyo
+*.pyd
+
+# Package
+/*egg-info
+/build
+/dist
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alexandro Sanchez Bach
+
+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
@@ -1,2 +1,12 @@
-# codeql-python
-Python bindings for CodeQL CLI
+CodeQL for Python
+=================
+
+[![](https://img.shields.io/pypi/v/codeql-python.svg)](https://pypi.python.org/pypi/codeql-python)
+
+Python 3.x bindings for the CodeQL CLI application.
+
+Install the package via:
+
+```bash
+pip install codeql-python
+````
diff --git a/codeql/__init__.py b/codeql/__init__.py
@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+CodeQL for Python.
+"""
+
+# Imports
+from .codeql import *
+
+# Prevent polluting namespace
+del codeql
diff --git a/codeql/codeql.py b/codeql/codeql.py
@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+CodeQL for Python.
+"""
+
+import subprocess
+
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,12 @@
+CodeQL for Python documentation
+===============================
+
+Disclaimer: This is a rather informal description.
+
+## Database
+
+TODO
+
+## Queries
+
+TODO
diff --git a/publish.bat b/publish.bat
@@ -0,0 +1,5 @@
+del dist\*
+python setup.py bdist_wheel --universal
+gpg --detach-sign -u FA31DF0C -a dist/*
+twine upload dist/*
+pause
diff --git a/setup.py b/setup.py
@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import codecs
+import setuptools
+
+CODEQL_VERSION = '2.4.5'
+CODEQL_REPOSITORY_URL = 'https://github.com/AlexAltea/codeql-python'
+CODEQL_DOWNLOAD_URL = 'https://github.com/AlexAltea/codeql-python/tarball/' + CODEQL_VERSION
+
+# Description
+CODEQL_DESCRIPTION = """CodeQL for Python
+=================
+
+.. image:: https://img.shields.io/pypi/v/codeql-python.svg
+    :target: https://pypi.python.org/pypi/codeql-python
+
+Python 3.x bindings for the CodeQL CLI application.
+
+More information at: https://github.com/AlexAltea/codeql-python
+"""
+
+setuptools.setup(
+    name='codeql-python',
+    version=CODEQL_VERSION,
+    description='Python bindings for CodeQL CLI',
+    long_description=CODEQL_DESCRIPTION,
+    license='MIT',
+    author='Alexandro Sanchez Bach',
+    author_email='alexandro@phi.nz',
+    url=CODEQL_REPOSITORY_URL,
+    download_url=CODEQL_DOWNLOAD_URL,
+    packages=['codeql-python'],
+    classifiers=[
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3.5',
+        'Natural Language :: English',
+    ],
+)
