Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
swh-core
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Platform
Development
swh-core
Commits
9812fe7e
Commit
9812fe7e
authored
5 years ago
by
David Douard
Browse files
Options
Downloads
Patches
Plain Diff
README: add a very short development setup guide
parent
9e29cfae
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!67
README: add a very short development setup guide
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+45
-0
45 additions, 0 deletions
README.md
with
45 additions
and
0 deletions
README.md
+
45
−
0
View file @
9812fe7e
...
...
@@ -6,3 +6,48 @@ core library for swh's modules:
-
hash computations
-
serialization
-
logging mechanism
-
database connection
-
http-based RPC client/server
Development
-----------
We strongly recommend you to use a
[
virtualenv
][
1
]
if you want to run tests or
hack the code.
To set up your development environment:
```
(swh) user@host:~/swh-environment/swh-core$ pip install -e .[testing]
```
This will install every Python package needed to run this package's tests.
Unit tests can be executed using
[
pytest
](
https://docs.pytest.org
)
.
```
(swh) user@host:~/swh-environment/swh-core$ pytest
============================== test session starts ==============================
platform linux -- Python 3.7.3, pytest-3.10.1, py-1.8.0, pluggy-0.12.0
hypothesis profile 'default' -> database=DirectoryBasedExampleDatabase('/home/ddouard/src/swh-environment/swh-core/.hypothesis/examples')
rootdir: /home/ddouard/src/swh-environment/swh-core, inifile: pytest.ini
plugins: requests-mock-1.6.0, hypothesis-4.26.4, celery-4.3.0, postgresql-1.4.1
collected 89 items
swh/core/api/tests/test_api.py .. [ 2%]
swh/core/api/tests/test_async.py .... [ 6%]
swh/core/api/tests/test_serializers.py ..... [ 12%]
swh/core/db/tests/test_db.py .... [ 16%]
swh/core/tests/test_cli.py ...... [ 23%]
swh/core/tests/test_config.py .............. [ 39%]
swh/core/tests/test_statsd.py ........................................... [ 87%]
.... [ 92%]
swh/core/tests/test_utils.py ....... [100%]
===================== 89 passed, 9 warnings in 6.94 seconds =====================
```
Please read the
[
developer setup manual
][
5
]
for more information on how to hack
on Software Heritage.
[
2
]:
https://docs.softwareheritage.org/devel/developer-setup.html
[
1
]:
https://virtualenv.pypa.io
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment