Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Deltacode documentation as part of Skeleton upgrade #189

Merged
merged 1 commit into from
Apr 3, 2023
Merged

Update Deltacode documentation as part of Skeleton upgrade #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
106 changes: 63 additions & 43 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
Deltacode
=========

+--------------+----------------------------------------------------------------------------------------------+
| **Branch** | **Linux (Travis)** |
+--------------+----------------------------------------------------------------------------------------------+
| develop |.. image:: https://travis-ci.com/nexB/deltacode.svg?token=9MXbiHv3xZxwT2egFxby&branch=develop |
| | :target: https://travis-ci.com/nexB/deltacode |
+--------------+----------------------------------------------------------------------------------------------+


DeltaCode is a simple command line utility that leverages the power
of `scancode-toolkit <https://github.com/nexB/scancode-toolkit>`_
to determine file-level differences between two codebases.
Expand All @@ -28,39 +19,61 @@ locations.
We are continuously working on new features, such as detecting copyright changes
and detecting package version changes.

Build and tests status
======================

Quick Start
===========
For more comprehensive installation instructions and development instructions, see:
`Comprehensive Installation <https://github.com/nexB/deltacode/wiki/Comprehensive-Installation>`_
We run tests on each commit on multiple CIs to ensure a good platform
compatibility with multiple versions of Windows, Linux and macOS.

For development instructions, see:
`Development Instructions <https://github.com/nexB/deltacode/wiki/Development>`_
+--------------+--------------+
| **Azure** | **RTD Build**|
+==============+==============+
| |azure| | |docs-rtd| |
+--------------+--------------+

Make sure you have Python 3.8+ installed:
* Download and install Python 3.8+ Windows
https://www.python.org/downloads/windows/
* Download and install Python 3.8+ for Mac
https://www.python.org/downloads/mac-osx/
* Download and install Python 3.8+ for Linux via distro package manager
Documentation
=============

Next, download and extract the latest DeltaCode release from::
The DeltaCode documentation is hosted at
`deltacode.readthedocs.io <https://deltacode.readthedocs.io/en/latest/>`_.

https://github.com/nexB/deltacode/releases/
Installation
============

Open a terminal, extract the downloaded release archive, then `cd` to
the extracted directory and run this command to display the command
help. DeltaCode will self-configure if needed::
Before installing DeltaCode make sure that you have installed the prerequisites
properly. This means installing Python 3.8 for x86/64 architectures.
We support Python 3.8, 3.9 and 3.10.

./deltacode --help
See `prerequisites <https://deltacode.readthedocs.io/en/latest/comprehensive_installation.html#prerequisites>`_
for detailed information on the support platforms and Python versions.

Run a sample delta
There are a few common ways to `install DeltaCode <https://deltacode.readthedocs.io/en/latest/comprehensive_installation.html>`_.

./deltacode -n samples/samples.json -o samples/samples.json
- `Development installation from source code using a git clone
<https://deltacode.readthedocs.io/en/latest/comprehensive_installation.html#source-code-install>`_

- `Development installation as a library with "pip install deltacode"
<https://deltacode.readthedocs.io/en/latest/comprehensive_installation.html#pip-install>`_

- `Run in a Docker container with a git clone and "docker run"
<https://deltacode.readthedocs.io/en/latest/comprehensive_installation.html#docker-install>`_


Quick Start
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there should be a sentence mentioning to run ./configure or ./configure --dev prior to running deltacode

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The above section of Quick Start is Installation. It has all the installation guides and I have linked it to the documentation page. See: Development installation from source code using a git clone. Moreover, Quick Start section is to guide everyone on how to use Deltacode.

I have kept the structure same as scancode-toolkit. Let me know what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see what you mean. That makes sense.

===========

Run this command to display the command
help::

deltacode --help

Run a sample delta::

deltacode -n samples/samples.json -o samples/samples.json

Run a simple delta saved to the `output.json` file::

./deltacode -n samples/samples.json -o samples/samples.json -j output.json
deltacode -n samples/samples.json -o samples/samples.json -j output.json

Then open `output.json` to view the delta results.

Expand All @@ -75,33 +88,40 @@ Support
If you have a problem, a suggestion or found a bug, please enter a ticket at:
https://github.com/nexB/deltacode/issues

For other questions, discussions, and chats, we have:
For discussions and chats, we have:

- an official Gitter channel at https://gitter.im/aboutcode-org/discuss
Gitter also has an IRC bridge at https://irc.gitter.im/
* an official Gitter channel for `web-based chats
<https://gitter.im/aboutcode-org/discuss>`_.
Gitter is also accessible via an `IRC bridge <https://irc.gitter.im/>`_.
There are other AboutCode project-specific channels available there too.

* an official `#aboutcode` IRC channel on liberachat (server web.libera.chat).
This channel receives build and commit notifications and can be noisy.
You can use your favorite IRC client or use the `web chat
<https://web.libera.chat/?#aboutcode>`_.

- an official #aboutcode IRC channel on liberachat (server web.libera.chat)
for DeltaCode and other related tools. Note that this receives
notifications from repos so it can be a tad noisy. You can use your
favorite IRC client or use the web chat at
https://web.libera.chat/?#aboutcode .


Source code
===========

* https://github.com/nexB/deltacode/releases
* https://github.com/nexB/deltacode.git
* https://pypi.org/project/deltacode/


License
=======

* Apache-2.0 with an acknowledgement required to accompany the delta output.

See the NOTICE file for more details.

See the NOTICE file and the .ABOUT files that document the origin and license of
the third-party code used in DeltaCode for more details.

Documentation & FAQ
===================
.. |azure| image:: https://dev.azure.com/nexB/deltacode/_apis/build/status/nexB.deltacode?branchName=develop
:target: https://dev.azure.com/nexB/deltacode/_build/latest?definitionId=1&branchName=develop
:alt: Azure tests status (Linux, macOS, Windows)

https://github.com/nexB/deltacode/wiki
.. |docs-rtd| image:: https://readthedocs.org/projects/deltacode/badge/?version=latest
:target: https://deltacode.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
10 changes: 5 additions & 5 deletions docs/source/deltacode/GSOC_2021_report.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,23 @@ Links
-----

..
[Project Link] https://summerofcode.withgoogle.com/organizations/5312205181943808/#6516503005888512
[Project Link] https://summerofcode.withgoogle.com/archive/2021/projects/6580434925780992

- `Project Details <https://summerofcode.withgoogle.com/organizations/5312205181943808/#6516503005888512>`_
- `Proposal <https://docs.google.com/document/d/19btijAja6x8hbD_X-dGor1RiiEGF3-1gEHYkzqzC3xQ/edit#heading=h.z6ne0og04bp5>`_
- `Project Details <https://summerofcode.withgoogle.com/archive/2021/projects/6580434925780992>`_
- `Proposal <https://docs.google.com/document/d/19btijAja6x8hbD_X-dGor1RiiEGF3-1gEHYkzqzC3xQ/edit>`_
- `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_
- `DeltaCode <https://github.com/nexB/deltacode>`_

------------

I’ve had a wonderful time during these three months and have learned plenty of things. I would
really like to thank `@pombredanne <https://github.com/pombredanne>`_,
`@majurg <https://github.com/majurg>`_, and `@JonoYang <https://github.com/JonoYang>`_ for their
`@steven-esser <https://github.com/steven-esser>`_, and `@JonoYang <https://github.com/JonoYang>`_ for their
constant support throughout the journey. From good job claps to nit-picky constructive
code-reviews, I enjoyed every bit of this GSoC project.

I had a wonderful time during the GSOC, I learned a lot of things during this time.I really
enjoyed this project. I would really like to thank my mentors
`@pombredanne <https://github.com/pombredanne>`_,
`@majurg <https://github.com/majurg>`_, and `@TG1999 <https://github.com/TG1999>`_,
`@steven-esser <https://github.com/steven-esser>`_, and `@TG1999 <https://github.com/TG1999>`_,
and all other About code members who constantly supported me throughout this project.