Developer documentation¶

  • __init__.py - Module definition
    • server.py - The CodeChat Server
    • render_manager.py - Render manager for the CodeChat Server
    • renderer.py - Renderers for the CodeChat Server
    • __main__.py - Run the CodeChat Server
    • constants.py - Constants
  • setup.py - Package and install the CodeChat Server
    • Contents
    • Release procedure
    • Packaging script
  • linux_installer.sh - The CodeChat System install script (Linux)
  • windows_installer.ps1 - Windows PowerShell Installation Script
    • Pre-Script Definitions
    • Case 1: No Python
    • Case 1: Old Python 2
    • Case 2: Old Python 3
    • Creating codechat venv
  • Tests
    • pre_commit_check.py - Run a series of checks that should all pass before submitting a pull request
    • test_server.py - Tests for ../CodeChat_Server/server.py
    • conftest.py - pytest fixtures for testing
    • ci_utils.py - Utilities supporting continuous integration tests
    • mypy.ini - mypy configuration
    • .flake8 - Flake8 configuration
    • pyproject.toml - Configuration for black and pytest
    • .coveragerc - Configure code coverage

Release procedures¶

See setup.py - Package and install the CodeChat Server.

The CodeChat System

Navigation

  • Common problems
  • Developer documentation
    • Contents
      • The CodeChat Server
        • User documentation
        • Developer docs
          • Developer documentation
            • __init__.py - Module definition
            • setup.py - Package and install the CodeChat Server
            • linux_installer.sh - The CodeChat System install script (Linux)
            • windows_installer.ps1 - Windows PowerShell Installation Script
            • Tests
            • Release procedures
      • The CodeChat Client
      • CodeChat editor/IDE extensions/plugins
      • CodeChat services
      • Change Log
      • conf.py - The CodeChat System documentation configuration
      • run_sphinx.bat - Run the Sphinx build from the command line
      • .gitignore - Files for Git to ignore
    • Release procedures
    • To do
    • Footnotes

Related Topics

  • Documentation overview
    • Developer documentation
      • The CodeChat Server
        • Previous: Security considerations
        • Next: __init__.py - Module definition

Quick search

©2023, Bryan A. Jones. | Powered by Sphinx 7.3.7 & Alabaster 0.7.16 | Page source