Merge pull request #17 from quaternionmedia/CodeCartographer

initial pull to main

.dockerignore

@@ -0,0 +1,27 @@
+**/__pycache__
+**/.venv
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

.gitignore

@@ -0,0 +1,154 @@
+### TODO: This was taken from a random repo. Update it to be more relevant to this project.
+# debug
+output/
+.dev/
+.vscode/
+..vscode/
+.git/
+
+# package files
+config.json
+default_config.json
+
+# General
+*.ipynb
+.pytype
+.DS_Store
+.vscode
+.idea
+mypy_report
+docs/build
+docs/source/_build
+tools/*.txt
+playground/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+.nox/
+*.pstats
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/ 
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.pyc
+*.so
+*.egg-info/
+dist/
+build/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+/docs-offline
+/mkdocs-nav-online.yml
+/mkdocs-nav-offline.yml
+
+# mypy
+.mypy_cache/
+
+# Snapshot testing report output directory
+tests/snapshot_tests/output
+
+# Sandbox folder - convenient place for us to develop small test apps without leaving the repo
+sandbox/
+
+# Cache of screenshots used in the docs
+.screenshot_cache
+
+# Used by mkdocs-material social plugin
+.cache

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Quaternion Media
+
+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.

README.md

@@ -1,2 +1,122 @@
-# CodeCartographer
-Dev project for mapping code
+# Codecarto:
+
+Development tool for mapping source code.
+
+Create graphs.
+
+Plot the graphs.
+
+Create JSON object of the graph.
+
+---
+
+## Installation
+
+### From pypi:
+
+```
+python -m venv venv
+
+.\venv\Scripts\activate
+
+pip install codecarto
+```
+
+### From Git [dev use]:
+
+clone repo
+
+open terminal
+
+navigate to repo
+
+```
+python -m venv venv
+
+.\venv\Scripts\activate
+
+pip install -e .
+```
+
+---
+
+## Usage
+
+### Help Information
+
+Check this first to see all usage information.
+
+```
+codecarto help
+```
+
+### Check output dir:
+
+To show the current output directory
+
+```
+codecarto output
+```
+
+### Change output:
+
+-s | --set : options can be used to set the output directory
+
+If directory does not exist, will ask if you'd like to make it
+
+```
+codecarto output -s DIR_PATH
+```
+
+### Demo:
+
+Parse the package source code
+
+```
+codecarto demo
+```
+
+### Passed file:
+
+Can pass a file or running script of source code in.
+
+```
+codecarto FILE_PATH
+```
+
+---
+
+## Testing
+
+Can test the package using nox commands.
+
+### All Tests
+
+```
+nox
+```
+
+### Session Tests
+
+Test the use of package as an imported library.
+
+```
+nox -s unit_test
+```
+
+Test the package CLI commands.
+
+```
+nox -s test_dir
+nox -s test_help
+nox -s test_output
+nox -s test_palette
+nox -s test_palette_import
+nox -s test_palette_export
+nox -s test_palette_reset
+nox -s test_palette_types
+nox -s test_palette_new
+nox -s test_demo
+nox -s test_empty
+nox -s test_file
+```

docker-compose.debug.yml

@@ -0,0 +1,17 @@
+# version: '3.4'
+
+# services:
+#   codecartographer:
+#     image: codecartographer
+#     build:
+#       context: .
+#       dockerfile: ./Dockerfile
+#     command:
+#       [
+#         'sh',
+#         '-c',
+#         "pip install debugpy -t /tmp && python /tmp/debugpy --wait-for-client --listen 0.0.0.0:5678 -m uvicorn src.codecarto\__init__:app --host 0.0.0.0 --port 2000",
+#       ]
+#     ports:
+#       - 2000:2000
+#       - 5678:5678

docker-compose.yml

@@ -0,0 +1,37 @@
+version: '3'
+
+services:
+  web:
+    build:
+      context: .
+      dockerfile: ./src/codecarto/containers/web/Dockerfile
+    ports:
+      - '2000:2000'
+    networks:
+      - external_network
+      - internal_network
+    volumes:
+      - ./src/codecarto/containers/web/src:/app/src
+
+  processor:
+    build:
+      context: .
+      dockerfile: ./src/codecarto/containers/processor/Dockerfile
+    networks:
+      - internal_network
+
+  database:
+    image: mongo:latest
+    ports:
+      - '27017:27017'
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: examplepassword
+    networks:
+      - internal_network
+
+networks:
+  external_network:
+    driver: bridge
+  internal_network:
+    driver: bridge