Skip to content

Commit 804843a

Browse files
keshav-spacekeshav-space
authored
Merge pull request #18 from aboutcode-org/refinements
Improve format, doc and configuration
2 parents eafb989 + 7e0d8f0 commit 804843a

File tree

292 files changed

+2522
-2301
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

292 files changed

+2522
-2301
lines changed

‎.env‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎.github/workflows/docs-ci.yml‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ on: [push, pull_request]
44

55
jobs:
66
build:
7-
runs-on: ubuntu-20.04
7+
runs-on: ubuntu-22.04
88

99
strategy:
1010
matrix:
11-
python-version: [3.9]
11+
python-version: ["3.10"]
1212

1313
steps:
1414
- name: Checkout code
@@ -20,14 +20,10 @@ jobs:
2020
python-version: ${{ matrix.python-version }}
2121

2222
- name: Install Dependencies
23-
run: pip install -e .[docs]
23+
run: ./configure --docs && make envfile
2424

2525
- name: Check Sphinx Documentation build minimally
26-
working-directory: ./docs
27-
run: sphinx-build -E -W source build
26+
run: make docs
2827

2928
- name: Check for documentation style errors
30-
working-directory: ./docs
31-
run: ./scripts/doc8_style_check.sh
32-
33-
29+
run: source venv/bin/activate && cd docs && ./scripts/doc8_style_check.sh

‎.github/workflows/main.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ name: run tests
33
on: [push, pull_request]
44

55
env:
6-
FEDERATED_CODE_HOST: 127.0.0.1
7-
FEDERATED_CODE_PORT: 8000
8-
FEDERATED_CODE_DOMAIN: 127.0.0.1:8000
6+
FEDERATEDCODE_HOST: 127.0.0.1
7+
FEDERATEDCODE_PORT: 8000
8+
FEDERATEDCODE_DOMAIN: 127.0.0.1:8000
99
POSTGRES_HOST: 127.0.0.1
1010
POSTGRES_DB: federatedcode
1111
POSTGRES_USER: federatedcode
@@ -38,12 +38,12 @@ jobs:
3838
run: make dev
3939

4040
- name: Run tests
41-
run: make test
41+
run: make envfile && make test
4242
env:
4343
GH_TOKEN: 1
44-
FEDERATED_CODE_HOST: ${{ env.FEDERATED_CODE_HOST }}
45-
FEDERATED_CODE_PORT: ${{ env.FEDERATED_CODE_PORT }}
46-
FEDERATED_CODE_DOMAIN: ${{ env.FEDERATED_CODE_DOMAIN }}
44+
FEDERATEDCODE_HOST: ${{ env.FEDERATEDCODE_HOST }}
45+
FEDERATEDCODE_PORT: ${{ env.FEDERATEDCODE_PORT }}
46+
FEDERATEDCODE_DOMAIN: ${{ env.FEDERATEDCODE_DOMAIN }}
4747
POSTGRES_HOST: ${{ env.POSTGRES_HOST }}
4848
POSTGRES_DB: ${{ env.POSTGRES_DB }}
4949
POSTGRES_USER: ${{ env.POSTGRES_USER }}

‎.gitignore‎

Lines changed: 79 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,50 @@
1-
# Python compiled files
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
23
*.py[cod]
4+
*$py.class
35

4-
# virtualenv and other misc bits
5-
/src/*.egg-info
6-
*.egg-info
7-
/dist
8-
/build
9-
/bin
10-
/lib
11-
/scripts
12-
/Scripts
13-
/Lib
14-
/pip-selfcheck.json
15-
/tmp
16-
/venv
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
1710
.Python
18-
/include
19-
/Include
20-
/local
21-
*/local/*
22-
/local/
23-
/share/
24-
/tcl/
25-
/.eggs/
11+
build/
12+
develop-eggs/
13+
dist/
14+
eggs/
15+
.eggs/
16+
lib/
17+
lib64/
18+
parts/
19+
sdist/
20+
var/
21+
wheels/
22+
*.egg-info/
23+
.installed.cfg
24+
*.egg
25+
2626

2727
# Installer logs
2828
pip-log.txt
29+
pip-delete-this-directory.txt
30+
pip-selfcheck.json
2931

3032
# Unit test / coverage reports
31-
.cache
33+
htmlcov/
34+
.tox/
3235
.coverage
3336
.coverage.*
34-
nosetests.xml
35-
htmlcov
37+
.cache
38+
coverage.xml
39+
*.cover
3640

3741
# Translations
3842
*.mo
43+
*.pot
3944

40-
# IDEs
41-
.project
42-
.pydevproject
43-
.idea
44-
org.eclipse.core.resources.prefs
45-
.vscode
46-
.vs
45+
# Django stuff:
46+
*.log
47+
local_settings.py
4748

4849
# Sphinx
4950
docs/_build
@@ -54,6 +55,51 @@ docs/Lib
5455
doc/pyvenv.cfg
5556
pyvenv.cfg
5657

58+
# PyBuilder
59+
target/
60+
61+
# Jupyter Notebook
62+
.ipynb_checkpoints
63+
64+
# pyenv and pip
65+
.python-version
66+
pyvenv.cfg
67+
bin/
68+
69+
# Environments
70+
.env
71+
.venv
72+
env/
73+
venv/
74+
ENV/
75+
76+
77+
# mypy
78+
.mypy_cache/
79+
80+
81+
# Database
82+
*.sqlite3*
83+
84+
# Staticfiles
85+
staticfiles/
86+
87+
# virtualenv
88+
bin
89+
include
90+
lib64
91+
share
92+
Pipfile
93+
94+
# editors
95+
.vscode
96+
# PyCharm
97+
.idea/
98+
99+
# pytest
100+
.pytest_cache
101+
102+
57103
# Various junk and temp files
58104
.DS_Store
59105
*~
@@ -62,6 +108,7 @@ pyvenv.cfg
62108
.ve
63109
*.bak
64110
/.cache/
111+
/tmp/
65112

66113
# pyenv
67114
/.python-version
@@ -72,4 +119,3 @@ tcl
72119

73120
# Ignore Jupyter Notebook related temp files
74121
.ipynb_checkpoints/
75-
.env

‎AUTHORS.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
The following organizations or individuals have contributed to this repo:
22

3-
-
3+
- @ziadhany Ziad Hany
4+
- @AboutCode-org
5+
- @pombredanne Philippe Ombredanne

‎CHANGELOG.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Changelog
22
=========
33

44

5-
v0.0.0
5+
v0.0.1
66
------
77

8-
*xxxx-xx-xx* -- Initial release.
8+
- 2024-05-31 -- Initial release.

‎Dockerfile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#
22
# Copyright (c) nexB Inc. and others. All rights reserved.
3-
# VulnerableCode is a trademark of nexB Inc.
3+
# FederatedCode is a trademark of nexB Inc.
44
# SPDX-License-Identifier: Apache-2.0
55
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
6-
# See https://github.com/nexB/vulnerablecode for support or download.
6+
# See https://github.com/nexB/federatedcode for support or download.
77
# See https://aboutcode.org for more information about nexB OSS projects.
88
#
99
FROM python:3.10

0 commit comments

Comments
 (0)