Merge pull request #5 from simple-repository/merge/internal-to-public

Merge the full history (warts and all), and move development of simple-repository-browser to github

Author: pelson

.gitignore

@@ -1,5 +1,20 @@
+simple_repository_browser/static_source/js/simple-repository-browser.project.js.LICENSE.txt
+simple_repository_browser/static_source/js/simple-repository-browser.core.js.LICENSE.txt
+simple_repository_browser/static_source/js/simple-repository-browser.core.js
+simple_repository_browser/static_source/js/simple-repository-browser.project.js
+
+*/_version.py
+node_modules
 *.egg-info
+venv
+*.sqlite
+cache
+logs
+
+
+__pycache__
+
 .idea
-simple_repository_browser/_version.py
-simple_repository_browser/static/js
-javascript/node_modules
+
+build/
+dist/

.pre-commit-config.yaml

@@ -25,4 +25,4 @@ repos:
       - id: flake8
         args:
           - "--max-line-length=100"
-          - '--ignore=E501,E226'
+          - '--ignore=E501,E226,W503,E402'

javascript/scss/app.scss

@@ -1,5 +1,3 @@
-@import "variables";
-
 // Limit the width as seen on pypi.
 $container-max-widths: (
   sm: 540px,
@@ -10,143 +8,3 @@ $container-max-widths: (
 );
 
 @import "~bootstrap/scss/bootstrap";
-
-.top-nav {
-   background: $base-color;
-}
-
-.nav-link {
-   color: white;
-}
-
-.nav-link:hover, .nav-link:focus {
-   color: white;
-}
-
-.navbar-brand {
-   font-size: xx-large;
-   color: white;
-   font-weight: bolder;
-}
-.navbar-brand:hover {
-   text-decoration: none;
-   color: white;
-}
-
-.jumbo-banner {
-   background: $base-color2;
-   color: white;
-   padding: 0px;
-   margin: 0px;
-}
-
-.jumbo-separator {
-   background-color: #ececec;
-   color: #464646;
-   border-bottom: 1px solid #d3d3d3;
-   padding: 1em;
-   margin-bottom: 1em;
-}
-
-
-a:hover, a:visited, a:link, a:active
-{
-    text-decoration: none;
-}
-
-
-.btn-link {
-   text-decoration: none;
-}
-
-nav a:hover {
-   text-decoration: underline;
-}
-
-.pip-command {
-   font-family: Source Code Pro, monospace;
-   font-weight: 500;
-   font-size: 1.2rem;
-   background-color: rgba(0, 0, 0, .15);
-   padding: 8px;
-   border: 1px dotted hsla(0, 0%, 100%, .4);
-   line-height: 30px;
-   white-space: nowrap;  // Long pip commands shouldn't wrap
-}
-
-.pip-command a, .pip-command a:hover {
-   color: white;
-}
-
-.listing-icon {
-   padding: 0 1em 0 0.5em;
-}
-
-footer {
-   background-color: $base-color;
-   color: white;
-   padding: 2em;
-}
-
-footer.text-muted.mt-auto {
-   color: white !important;
-   margin-top: 2em !important;
-}
-
-.btn-primary, .btn-primary:hover, .btn-primary:active, .btn-primary:focus {
-   background-color:  $base-color;
-   border-color:  $base-color;
-   box-shadow: none;  // On focus otherwise
-}
-
-dev#page-content a:hover {
-   color: $base-color;
-}
-
-
-a.status-badge {
-   font-weight: 400;
-   line-height: 1.4;
-   border: 1px solid hsla(0, 0%, 100%, .5);
-   border-radius: 3px;
-   box-sizing: border-box;
-   display: inline-flex;
-   font-size: .8rem;
-   min-height: 40px;
-   padding: 12px;
-   color: #fff;
-}
-
-a.status-badge--bad {
-   background-color: #d52d40;
-}
-
-a.status-badge--good {
-   background-color: #148024;
-}
-
-img {
-   max-width: 100%;
-}
-
-
-.link-unstyled, .link-unstyled:link, .link-unstyled:hover {
-  color: inherit;
-  text-decoration: inherit;
-}
-
-
-.base-color {
-   background: $base-color !important;
-   color: white !important;
-}
-
-.secondary-color {
-   background: $base-color2 !important;
-   color: white !important;
-}
-
-
-.m-1em {
-   margin: 1em;
-}

javascript/simple-repository-browser.core.js

@@ -1,12 +1,8 @@
-/*
- * Copyright (C) 2023, CERN
- * This software is distributed under the terms of the MIT
- * licence, copied verbatim in the file "LICENSE".
- * In applying this license, CERN does not waive the privileges and immunities
- * granted to it by virtue of its status as Intergovernmental Organization
- * or submit itself to any jurisdiction.
- */
+import './scss/app.scss';
+
+import 'popper.js';  // Needed for bootstrap tooltips.
 
 import 'bootstrap';
 
-import './scss/app.scss';
+// Expose bootstrap, so that we can initiate some events with it (like enabling tooltips).
+window.bootstrap = require('bootstrap/dist/js/bootstrap.bundle.js');

javascript/simple-repository-browser.project.js

@@ -1,12 +1,3 @@
-/*
- * Copyright (C) 2023, CERN
- * This software is distributed under the terms of the MIT
- * licence, copied verbatim in the file "LICENSE".
- * In applying this license, CERN does not waive the privileges and immunities
- * granted to it by virtue of its status as Intergovernmental Organization
- * or submit itself to any jurisdiction.
- */
-
 import $ from 'jquery';
 window.jQuery = $;
 window.$ = $;

javascript/webpack.config.js

@@ -1,12 +1,3 @@
-/*
- * Copyright (C) 2023, CERN
- * This software is distributed under the terms of the MIT
- * licence, copied verbatim in the file "LICENSE".
- * In applying this license, CERN does not waive the privileges and immunities
- * granted to it by virtue of its status as Intergovernmental Organization
- * or submit itself to any jurisdiction.
- */
-
 const path = require('path');
 
 module.exports = {
@@ -16,7 +7,7 @@ module.exports = {
   },
   output: {
     filename: '[name]',
-    path: path.resolve(__dirname, '../simple_repository_browser/static/js/')
+    path: path.resolve(__dirname, '../simple_repository_browser/static_source/js/')
   },
   resolve: {
     extensions: [".ts", ".js"],

pyproject.toml

@@ -29,10 +29,12 @@ dependencies = [
   "markupsafe",
   "packaging",
   "parsley",
-  "pkginfo",
+  "pkginfo>=1.12",
   "readme-renderer[md]",
-  "simple-repository>=0.6",
+  "simple-repository~=0.9",
   "uvicorn",
+  "authlib",
+  "starlette[full]",
 ]
 readme = "README.md"
 
@@ -50,14 +52,23 @@ dev = [
 [project.scripts]
 simple-repository-browser = "simple_repository_browser.__main__:main"
 
-
 [tool.setuptools_scm]
 version_file = "simple_repository_browser/_version.py"
 
+[tool.isort]
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+line_length = 88
+force_sort_within_sections = true
+
 [[tool.mypy.overrides]]
 module = [
     "diskcache",
     "parsley",
+    "setuptools",
 ]
 ignore_missing_imports = true
 

setup.py

@@ -0,0 +1,16 @@
+import pathlib
+import sys
+
+from setuptools import setup
+
+sys.path.insert(0, 'simple_repository_browser')
+from _compile_static import compile_static_files  # type: ignore[import-not-found]
+
+root = pathlib.Path(__file__).parent
+
+static_dir = root / 'simple_repository_browser' / 'static_source'
+dest = root / 'simple_repository_browser' / 'static'
+
+compile_static_files(destination=dest, sources=[static_dir])
+
+setup()

simple_repository_browser/__main__.py

@@ -1,10 +1,11 @@
 import argparse
 import logging
 import os
-import typing
 from pathlib import Path
+import typing
 
 import uvicorn
+from uvicorn.config import LOGGING_CONFIG
 
 from . import __version__
 from ._app import AppBuilder
@@ -47,10 +48,19 @@ def handler(args: typing.Any) -> None:
         browser_version=__version__,
     ).create_app()
 
+    log_conf = LOGGING_CONFIG.copy()
+    log_conf["formatters"]["default"]["fmt"] = "%(asctime)s [%(name)s] %(levelprefix)s %(message)s"
+    log_conf["formatters"]["access"][
+        "fmt"
+    ] = '%(asctime)s [%(name)s] %(levelprefix)s %(client_addr)s - "%(request_line)s" %(status_code)s'
+
     uvicorn.run(
         app=app,
         host=args.host,
         port=args.port,
+        proxy_headers=True,
+        forwarded_allow_ips="*",
+        log_config=log_conf,
     )
 
 

simple_repository_browser/_app.py

@@ -1,7 +1,7 @@
 import logging
+from pathlib import Path
 import sqlite3
 import typing
-from pathlib import Path
 from urllib.parse import urlparse
 
 import aiosqlite
@@ -107,7 +107,7 @@ async def catch_exceptions_middleware(request: fastapi.Request, call_next):
         return app
 
     def create_view(self) -> view.View:
-        return view.View(self.template_paths, self.browser_version)
+        return view.View(self.template_paths, self.browser_version, static_files_path=self.static_files_path)
 
     def create_crawler(self, http_client: httpx.AsyncClient, source: SimpleRepository) -> crawler.Crawler:
         return crawler.Crawler(