WIP

docs/CNAME

@@ -0,0 +1 @@
+www.djangobim.com

docs/assets/style/extra.css

@@ -0,0 +1,16 @@
+@import url('https://fonts.googleapis.com/css2?family=Manrope&display=swap');
+@font-face {
+    font-family: "Manrope";
+    src: "fonts/manrope/manrope-regular.woff2";
+}
+:root {
+    --md-text-font: "Manrope"; 
+}
+.md-footer__inner {
+    display: none;
+}
+[data-md-color-scheme="scapeagency"] {
+    --md-primary-fg-color:        rgb(0, 0, 15);
+    --md-primary-fg-color--light: #ffffff;
+    --md-primary-fg-color--dark:  rgb(0, 0, 15);
+}

docs/index.md

@@ -0,0 +1,12 @@
+<header>
+<p align="center">
+    <img src="assets/image/logo_dark.png" width="20%" height="20%" alt="Stylescape Logo">
+</p>
+<h1 align='center' style='border-bottom: none;'>jango LAN</h1>
+<!-- <h3 align='center'></h3> -->
+</header>
+<br/>
+
+**Django LAN** is a multichannel identity framework.
+
+**jango LAN** is an open-source project by [Starling Associates](https://www.starling.associates "Starling Associates website").

docs/legal/disclaimer.md

@@ -0,0 +1,3 @@
+# Disclaimer
+
+**THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**

docs/overrides/_main.html

@@ -0,0 +1,7 @@
+{% extends "base.html" %}
+
+{% block announce %}
+    <div>
+      <strong> Django BIM is currently a <i>Work in Progress</i></strong>
+    </div>
+{% endblock %}

docs/quick_start.md

@@ -0,0 +1,3 @@
+# Quick Start
+
+## Installation

docs/resources/glossary.md

@@ -0,0 +1 @@
+# Glossary

docs/resources/links.md

@@ -0,0 +1 @@
+# Links

docs/robots.txt

@@ -0,0 +1,8 @@
+# www.robotstxt.org/
+
+# Allow crawling of all content
+User-agent: *
+Disallow:
+
+
+SITEMAP: http://www.djangolan.com/sitemap.xml

docs/security.txt

@@ -0,0 +1,8 @@
+# Canonical
+Canonical: https://www.scape.style/security.txt
+
+# Contact
+Contact: mailto:[email protected]
+
+# Preferred-Languages
+Preferred-Languages: en

mkdocs.yml

@@ -0,0 +1,180 @@
+# Project Information
+site_name: Stylescape
+site_url: https://www.djangolan.com/
+site_description: A Django plugin to manage Local Area Networks
+site_author: Starling Associates
+lang: en
+
+# Repository
+repo_name: 'GitHub'
+repo_url: https://github.com/starling-cloud/stylescape/
+edit_uri_template: 'docs/{path}'
+dev_addr: 127.0.0.1:8888
+
+# Copyright
+copyright: >
+  Copyright &copy; 2024 <a href="https://www.starling.associates">Starling Associates</a>. All Rights Reserved.
+
+
+# hide:
+#   - footer
+
+# Configuration
+theme:
+  name: material
+  custom_dir: 'docs/overrides'
+  locale: en
+  language: en
+  palette:
+    scheme: scapeagency
+  # palette:
+  #   - scheme: default
+  #     primary: indigo
+  #     accent: indigo
+  #     toggle:
+  #       icon: material/brightness-7
+  #       name: Switch to dark mode
+  #   - scheme: slate
+  #     primary: indigo
+  #     accent: indigo
+  #     toggle:
+  #       icon: material/brightness-4
+  #       name: Switch to light mode
+  # font:
+  #   text: 'Manrope'
+  #   code: 'Roboto Mono'
+  logo: assets/image/scape_agency-logo_transparent.png
+  favicon: assets/favicon/favicon.ico
+  features:
+    # - announce.dismiss
+    # - content.action.edit
+    # - content.action.view
+    # - content.code.annotate
+    # - content.code.copy
+    # - content.tabs.link
+    - content.tooltips
+    # - header.autohide
+    # - navigation.expand
+    - navigation.footer
+    - navigation.indexes
+    # - navigation.instant
+    # - navigation.prune
+    # - navigation.sections
+    # - navigation.tabs
+    # - navigation.tabs.sticky
+    # - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    # - toc.integrate
+
+# Plugins
+plugins:
+  - search:
+      lang: en
+      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
+  - mkdocstrings:
+  #   custom_templates: templates
+      default_handler: python
+      handlers:
+        python:
+          options:
+            # Heading options
+            heading_level: 2
+            show_root_heading: false
+            show_root_toc_entry: false
+            show_root_full_path: false
+            show_root_members_full_path: false
+            show_object_full_path: false
+            show_category_heading: false
+            # Additional options
+            show_bases: true
+            show_source: false
+
+# Customization
+extra:
+  generator: false
+  analytics:
+    provider: google
+    property: G-QC1W520T96
+  social:
+    - icon: fontawesome/solid/globe 
+      link: https://www.starling.associates
+    - icon: fontawesome/brands/github 
+      link: https://github.com/starling-cloud/
+    - icon: fontawesome/brands/linkedin 
+      link: https://www.linkedin.com/company/starling-associates/
+    - icon: fontawesome/brands/instagram 
+      link: https://www.instagram.com/starling.associates/
+    - icon: fontawesome/brands/facebook 
+      link: https://www.facebook.com/starling.associates/
+  # consent:
+  #   title: Cookie consent
+  #   description: >- 
+  #     We use cookies to recognize your repeated visits and preferences, as well
+  #     as to measure the effectiveness of our documentation and whether users
+  #     find what they're searching for. With your consent, you're helping us to
+  #     make our documentation better.
+extra_css:
+  - assets/style/extra.css
+extra_javascript:
+  - assets/script/extra.js
+extra_templates:
+
+
+# Extensions
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  # - toc:
+  #     permalink: true
+  # - pymdownx.arithmatex:
+  #     generic: true
+  # - pymdownx.betterem:
+  #     smart_enable: all
+  # - pymdownx.caret
+  # - pymdownx.details
+  # - pymdownx.emoji:
+  #     emoji_generator: !!python/name:materialx.emoji.to_svg
+  #     emoji_index: !!python/name:materialx.emoji.twemoji
+  # - pymdownx.highlight:
+  #     anchor_linenums: true
+  # - pymdownx.inlinehilite
+  # - pymdownx.keys
+  # - pymdownx.magiclink:
+  #     repo_url_shorthand: true
+  #     user: squidfunk
+  #     repo: mkdocs-material
+  # - pymdownx.mark
+  # - pymdownx.smartsymbols
+  # - pymdownx.superfences:
+  #     custom_fences:
+  #       - name: mermaid
+  #         class: mermaid
+  #         format: !!python/name:pymdownx.superfences.fence_code_format
+  # - pymdownx.tabbed:
+  #     alternate_style: true
+  # - pymdownx.tasklist:
+  #     custom_checkbox: true
+  # - pymdownx.tilde
+
+
+# Page tree
+nav:
+  - Introduction: 'index.md'
+  - Quick Start: 'quick_start.md'
+  - Resources:
+      - 'Glossary': 'resources/glossary.md'
+      - 'Links': 'resources/links.md'
+  - About:
+      - 'Authors': 'about/authors.md'
+  - Legal Information:
+      - 'License': 'legal/license.md'
+      - 'Privacy Policy': 'legal/privacy_policy.md'
+      - 'Disclaimer': 'legal/disclaimer.md'

pyproject.toml

@@ -4,9 +4,11 @@ version = "0.0.1"
 description = "A Django plugin to manage building data based on IFC"
 authors = ["Starling Associates <[email protected]>"]
 license = "Apache-2.0"
-
+homepage = "https://www.djangobim.com"
+repository = "https://github.com/starling-cloud/django-bim"
+documentation = "https://www.djangobim.com/docs"
 packages = [
-    { include = "django-bim", from = "src" },
+    { include = "django_bim", from = "src" },
 ]
 
 [tool.poetry.dependencies]
@@ -15,19 +17,17 @@ Django = "^4.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.0"
-
-
+black = "^22.3"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.poetry.scripts]
-django_ifc_manage = "django_ifc.manage:main"
-
 [tool.poetry.urls]
-"Homepage" = "https://github.com/starling-cloud/django-bim"
+"Homepage" = "https://www.djangobim.com"
 "Repository" = "https://github.com/starling-cloud/django-bim"
+"Documentation" = "https://www.djangobim.com/docs"
+"Tracker" = "https://github.com/starling-cloud/django-bim/issues"
 
 [tool.black]
-line-length = 79
+line-length = 79

src/django-bim/apps.py → src/django_bim/apps.py

@@ -58,14 +58,14 @@ class DjangoBimConfig(AppConfig):
     """
 
     # Full Python path to the application
-    name = 'django-bim'
+    name = "django-bim"
 
     # Short name for the application, used in relation naming
-    label = 'django-bim'
+    label = "django-bim"
 
     # Human-readable name for the application
     verbose_name = _("Django BIM")
 
     # Specifies the type of primary key to use by default for models in
     # this application
-    default_auto_field = 'django.db.models.BigAutoField'
+    default_auto_field = "django.db.models.BigAutoField"