cgitize 5.0.0__tar.gz → 5.0.2__tar.gz

{cgitize-5.0.0 → cgitize-5.0.2}/.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
     name: 'Test / ${{ matrix.python-version }}'
     env:
       CGITIZE_GITHUB_USERNAME: cgitize-test

{cgitize-5.0.0 → cgitize-5.0.2}/DEVELOPMENT.md

@@ -43,3 +43,5 @@ Releases
 
 * Make a git tag for a new minor version using `make tag`.
 You can then review it and push using `git push --tags`.
+* For a new major version, update the version in the docker-compose definition
+in docker/README.md.

{cgitize-5.0.0/cgitize.egg-info → cgitize-5.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cgitize
-Version: 5.0.0
+Version: 5.0.2
 Summary: Self-host your repositories using cgit
 Author-email: Egor Tensin <Egor.Tensin@gmail.com>
 License: MIT
@@ -13,6 +13,11 @@ Classifier: Topic :: Software Development :: Version Control :: Git
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: atlassian-python-api~=3.28.0
+Requires-Dist: importlib-metadata~=4.0; python_version < "3.8"
+Requires-Dist: PyGithub~=1.0
+Requires-Dist: python-gitlab~=2.0
+Requires-Dist: tomli~=1.0
 
 cgitize
 =======
@@ -27,7 +32,7 @@ Supports cloning all of your repositories from major hosting providers:
 * Bitbucket,
 * GitLab.
 
-Example output can be found at https://git.egort.name/.
+Example output can be found at https://git.tensin.name/.
 
 Installation
 ------------

{cgitize-5.0.0 → cgitize-5.0.2}/README.md

@@ -11,7 +11,7 @@ Supports cloning all of your repositories from major hosting providers:
 * Bitbucket,
 * GitLab.
 
-Example output can be found at https://git.egort.name/.
+Example output can be found at https://git.tensin.name/.
 
 Installation
 ------------

{cgitize-5.0.0 → cgitize-5.0.2/cgitize.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cgitize
-Version: 5.0.0
+Version: 5.0.2
 Summary: Self-host your repositories using cgit
 Author-email: Egor Tensin <Egor.Tensin@gmail.com>
 License: MIT
@@ -13,6 +13,11 @@ Classifier: Topic :: Software Development :: Version Control :: Git
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: atlassian-python-api~=3.28.0
+Requires-Dist: importlib-metadata~=4.0; python_version < "3.8"
+Requires-Dist: PyGithub~=1.0
+Requires-Dist: python-gitlab~=2.0
+Requires-Dist: tomli~=1.0
 
 cgitize
 =======
@@ -27,7 +32,7 @@ Supports cloning all of your repositories from major hosting providers:
 * Bitbucket,
 * GitLab.
 
-Example output can be found at https://git.egort.name/.
+Example output can be found at https://git.tensin.name/.
 
 Installation
 ------------

{cgitize-5.0.0 → cgitize-5.0.2}/cgitize.egg-info/SOURCES.txt

@@ -42,8 +42,10 @@ docker/frontend/etc/nginx/conf.d/default.conf
 docker/frontend/usr/lib/cgit/filters/about-formatting.sh
 docker/frontend/usr/lib/cgit/filters/html-converters/.gitattributes
 docker/frontend/usr/lib/cgit/filters/html-converters/md2html
+docs/api.md
 docs/auth.md
 examples/cgitize.toml
+examples/docker/cgitize.toml
 test/__init__.py
 test/integration/docker/.dockerignore
 test/integration/docker/docker-compose.yml

{cgitize-5.0.0 → cgitize-5.0.2}/docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.11-alpine AS base
+FROM python:3.12-alpine AS base
 
 FROM base AS deps
 

{cgitize-5.0.0 → cgitize-5.0.2}/docker/README.md

@@ -39,11 +39,35 @@ It could look like this:
 Compose
 -------
 
-See the root docker-compose.yml file for a possible services definition.
-In this configuration, cgitize pulls my repositories from GitHub every 3 hours.
-You can test it by running
+Here's an example docker-compose.yml file:
+
+    version: '3'
+
+    services:
+      cgitize:
+        environment:
+          # Every 3 hours:
+          SCHEDULE: '0 */3 * * *'
+          # Set CGITIZE_{GITHUB,BITBUCKET,GITLAB}_{USERNAME,TOKEN} variables
+          # here or in the config file.
+        image: egortensin/cgitize:5
+        restart: unless-stopped
+        volumes:
+          - ./example.toml:/etc/cgitize/cgitize.toml:ro
+          - /srv/volumes/cgitize:/mnt/cgitize
+      frontend:
+        image: egortensin/cgitize-frontend:5
+        ports:
+          - '127.0.0.1:80:80'
+        restart: unless-stopped
+        volumes:
+          - /srv/volumes/cgitize:/mnt/cgitize:ro
+
+In this configuration, cgitize pulls repositories defined in example.toml every
+3 hours and puts them to /srv/volumes/cgitize on the host.
+
+To launch containers, run:
 
-    docker-compose build
     docker-compose up -d
 
-and visiting http://localhost:80/.
+To inspect the repositories, visit http://localhost:80/.

{cgitize-5.0.0 → cgitize-5.0.2}/docker/frontend/Dockerfile

@@ -1,9 +1,9 @@
-FROM nginx:1.24-alpine AS base
+FROM nginx:1.25-alpine AS base
 
 FROM base AS builder
 
 # Install cmark-gfm:
-ARG CMARK_GFM_VERSION=0.29.0.gfm.11
+ARG CMARK_GFM_VERSION=0.29.0.gfm.13
 ADD ["https://github.com/github/cmark-gfm/archive/refs/tags/$CMARK_GFM_VERSION.zip", "/"]
 
 RUN apk add -q --no-cache cmake g++ make python3 && \

{cgitize-5.0.0 → cgitize-5.0.2}/docker-compose.yml

@@ -1,14 +1,7 @@
-version: '3.4'
-
-x-default-settings:
-  &default-settings
-  logging:
-    driver: journald
-  restart: unless-stopped
+version: '3'
 
 services:
   cgitize:
-    << : *default-settings
     build:
       context: .
       dockerfile: docker/Dockerfile
@@ -16,16 +9,17 @@ services:
       # Every 3 hours:
       SCHEDULE: '0 */3 * * *'
     image: egortensin/cgitize:latest
+    restart: unless-stopped
     volumes:
       - ./examples/docker:/etc/cgitize:ro
       - repositories:/mnt/cgitize
   frontend:
-    << : *default-settings
     build:
       context: ./docker/frontend
     image: egortensin/cgitize-frontend:latest
     ports:
       - '127.0.0.1:80:80'
+    restart: unless-stopped
     volumes:
       - repositories:/mnt/cgitize:ro
 

cgitize-5.0.2/docs/api.md

@@ -0,0 +1,57 @@
+This project supports GitHub, Bitbucket & GitLab.  All of them are,
+unfortunately, peculiar in their own way.
+
+Tokens
+------
+
+All of the forges support access tokens, of course (although they're called
+"app passwords" on Bitbucket).  They can be used to do `git clone https://`
+with authentication info in the URL.  For GitHub, it's enough to just specify
+the token:
+
+    git clone https://TOKEN@github.com/USER/REPO.git
+
+For Bitbucket & GitLab, however, you need to specify both the user and the
+token in the URL:
+
+    git clone https://USER:TOKEN@bitbucket.org/USER/REPO.git
+
+Terminology
+-----------
+
+* GitHub has users and organizations; both of which can have repositories.
+    * A user can be a collaborator on a different user's repository, while an
+organization (I think) can only fully own its repositories.
+* Bitbucket has user accounts, workspaces & projects.  User accounts own (or
+are invited to) workspaces, which include projects.
+    * Not so long ago, when workspaces were introduced, all users got a default
+workspace matching their username (with an untitled project).
+    * Each repository belongs to a project, which belongs to a workspace.
+There can be multiple users collaborating on a workspace, which includes one or
+more projects, which include repositories.  What an amazing concept!  I
+couldn't be happier to deal with this.
+* GitLab sorta has users and organizations (called "groups") here.  I'm pretty
+sure they're called "namespaces" really, and are the same as Bitbucket's
+"workspaces", but whatever.
+
+API
+---
+
+* If you authenticate with GitHub and call `/users/USER/repos` for the
+authenticated user, you will [only get public repositories].  Why?  Who knows.
+    * You need to call `/user/repos` to include private repositories.
+    * You _might_ want to use the `affiliation` parameter to only get owned
+repositories.  Otherwise, you'll get all repositories in all orgs you're a
+member of, etc.
+* For Bitbucket, `/repositories/WORKSPACE` does [include private repositories]
+(if you're authenticated, of course).
+    * When somebody else invites you to collaborate on a repository, you get
+access to a different workspace; this repository is not added to your workspace
+or anything.
+* GitLab will, helpfully, only return projects [owned by the user] when
+`/users/USER/projects` is called.
+
+[only get public repositories]: https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-repositories-for-a-user
+[call /user/repos]: https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-repositories-for-the-authenticated-user
+[include private repositories]: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-repositories-workspace-get
+[owned by the user]: https://docs.gitlab.com/ee/api/projects.html#list-user-projects

cgitize-5.0.2/examples/docker/cgitize.toml

@@ -0,0 +1,7 @@
+clone_via_ssh = false
+clone_url = "http://localhost/{repo}"
+
+[github]
+
+[github.users.me]
+name = "egor-tensin"

{cgitize-5.0.0 → cgitize-5.0.2}/prelude.mk

@@ -1,4 +1,4 @@
-# Please see https://egort.name/blog/notes/makefile.html
+# Please see https://tensin.name/blog/notes/makefile.html
 
 MAKEFLAGS += --no-builtin-rules --no-builtin-variables --warn-undefined-variables
 unexport MAKEFLAGS

{cgitize-5.0.0 → cgitize-5.0.2}/requirements.txt

@@ -1,10 +1,10 @@
 atlassian-python-api==3.28.1
-certifi==2023.7.22
-cffi==1.15.1
-charset-normalizer==3.2.0
-cryptography==41.0.3
+certifi==2023.11.17
+cffi==1.16.0
+charset-normalizer==3.3.2
+cryptography==41.0.7
 Deprecated==1.2.14
-idna==3.4
+idna==3.6
 oauthlib==3.2.2
 pycparser==2.21
 PyGithub==1.59.1
@@ -16,5 +16,5 @@ requests-oauthlib==1.3.1
 requests-toolbelt==1.0.0
 six==1.16.0
 tomli==1.2.3
-urllib3==2.0.4
-wrapt==1.15.0
+urllib3==2.1.0
+wrapt==1.16.0

{cgitize-5.0.0 → cgitize-5.0.2}/test/integration/docker/git_server/Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.18
+FROM alpine:3.19
 
 RUN apk add -q --no-cache bash git openssh-server tini && \
     echo 'root:root' | chpasswd && \