change pip packaging to have actual separate packages for besapi and bescli

Author: jgstew

.flake8

@@ -0,0 +1,20 @@
+[flake8]
+select = B,C,E,F,P,W,B9
+max-line-length = 88
+extend-ignore = E203, W503, F401
+
+### DEFAULT IGNORES FOR 4-space INDENTED PROJECTS ###
+# E127, E128 are hard to silence in certain nested formatting situations.
+# E203 doesn't work for slicing
+# E265, E266 talk about comment formatting which is too opinionated.
+# E402 warns on imports coming after statements. There are important use cases
+# that require statements before imports.
+# E501 is not flexible enough, we're using B950 instead.
+# E722 is a duplicate of B001.
+# P207 is a duplicate of B003.
+# P208 is a duplicate of C403.
+# W503 talks about operator formatting which is too opinionated.
+ignore = E127, E128, E203, E265, E266, E402, E501, E722, P207, P208, W503
+exclude =
+    .git
+    __pycache__

.github/workflows/test_build.yaml

@@ -0,0 +1,44 @@
+---
+name: test_build
+
+on:
+  push:
+    paths:
+      - "**.py"
+      - "setup.cfg"
+      - "MANIFEST.in"
+      - "pyproject.toml"
+      - "requirements.txt"
+      - ".github/workflows/test_build.yaml"
+      - ".github/workflows/tag_and_release.yaml"
+  pull_request:
+    paths:
+      - "**.py"
+      - "setup.cfg"
+      - "MANIFEST.in"
+      - "pyproject.toml"
+      - "requirements.txt"
+      - ".github/workflows/test_build.yaml"
+      - ".github/workflows/tag_and_release.yaml"
+
+jobs:
+  test_build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Install requirements
+        run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Install build tools
+        run: pip install setuptools wheel build
+      - name: Run build
+        run: python3 -m build
+      - name: Get Wheel File Path
+        id: getwheelfile
+        shell: bash
+        run: echo "::set-output name=wheelfile::$(find "dist" -type f -name "*.whl")"
+      - name: Test pip install of wheel
+        run: pip install ${{ steps.getwheelfile.outputs.wheelfile }}

.github/workflows/yamllint.yaml

@@ -0,0 +1,29 @@
+---
+name: yamllint
+
+on:
+  push:
+    paths:
+      - "**.yaml"
+      - "**.yml"
+  pull_request:
+    paths:
+      - "**.yaml"
+      - "**.yml"
+
+jobs:
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install yamllint
+        run: pip install yamllint
+
+      - name: Lint YAML files
+        run: yamllint . -f parsable

.pylintrc

@@ -0,0 +1,5 @@
+[MESSAGES CONTROL]
+disable = C0330, C0326, C0103, c-extension-no-member
+
+[format]
+max-line-length = 88

.yamllint.yaml

@@ -0,0 +1,13 @@
+---
+extends: default
+
+rules:
+  # for some reason my github actions YAML trip this one but I don't understand why
+  truthy:
+    level: warning
+  # 88 chars should be enough, but don't fail if a line is longer
+  line-length:
+    max: 88
+    level: warning
+  new-lines:
+    level: warning

MANIFEST.in

@@ -1 +1 @@
-include schemas/*.xsd
+include src/besapi/schemas/*.xsd

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name="besapi",
-    version="0.6",
+    version="0.7",
     author="Matt Hansen",
     author_email="hansen.m@psu.edu",
     description="Library for working with the BigFix REST API",
@@ -18,10 +18,11 @@
         "python-besapi is a Python library designed to "
         "interact with the BES (BigFix) REST API."
     ),
-    py_modules=["besapi", "bescli"],
+    packages=["besapi","bescli"],
     package_data={
         "besapi": ["schemas/*.xsd"],
     },
     install_requires=["requests", "lxml", "cmd2"],
     include_package_data=True,
+    package_dir={"": "src"},
 )

__init__.py src/besapi/__init__.py

@@ -1,3 +1,4 @@
 # https://stackoverflow.com/questions/279237/import-a-module-from-a-relative-path/4397291
 
-from .besapi import *
+from . import besapi
+

src/besapi/__main__.py

@@ -0,0 +1,6 @@
+"""
+To run this module directly
+"""
+from bescli import bescli
+
+bescli.main()

besapi.py src/besapi/besapi.py

@@ -10,6 +10,9 @@
 Library for communicating with the BES (BigFix) REST API.
 """
 
+import site
+import os.path
+
 import requests
 from lxml import etree, objectify
 from pkg_resources import resource_filename
@@ -171,7 +174,11 @@ def objectify_text(self, text):
         return objectify.fromstring(root_xml)
 
 def main():
-    import bescli
+    try:
+        from bescli import bescli
+    except ImportError:
+        site.addsitedir(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+        from bescli import bescli
     bescli.main()
 
 

schemas/BES.xsd src/besapi/schemas/BES.xsd

@@ -0,0 +1,3 @@
+# https://stackoverflow.com/questions/279237/import-a-module-from-a-relative-path/4397291
+
+from . import bescli

schemas/BESAPI.xsd src/besapi/schemas/BESAPI.xsd

@@ -2,6 +2,6 @@
 To run this module directly
 """
 from . import bescli
-from . import besapi
+#import besapi
 
 bescli.main()

schemas/BESActionSettings.xsd src/besapi/schemas/BESActionSettings.xsd

@@ -14,6 +14,7 @@
 import argparse
 import getpass
 import sys
+import site
 
 from cmd2 import Cmd
 try:
@@ -23,7 +24,15 @@
 
 #from lxml import etree, objectify
 
-import besapi
+try:
+    from besapi import besapi
+except ModuleNotFoundError:
+    # add the module path
+    site.addsitedir(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+    from besapi import besapi
+except ImportError:
+    # this is for the case in which we are calling bescli from besapi
+    import besapi
 
 class BESCLInterface(Cmd):
     """BES (BigFix) command-line interface processor."""