launchpad-reviewers team mailing list archive

[Tushar Gupta <mp+489999@xxxxxxxxxxxxxxxxxx>]

Tushar Gupta has proposed merging ~tushar5526/lp-codeimport:fix-readme-and-sys-deps into lp-codeimport:focal.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~tushar5526/lp-codeimport/+git/lp-codeimport/+merge/489999
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~tushar5526/lp-codeimport:fix-readme-and-sys-deps into lp-codeimport:focal.

diff --git a/README b/README
index 9e570d4..4a94fae 100644
--- a/README
+++ b/README
@@ -1,97 +1,66 @@
-====================
-README for Launchpad
-====================
+# Launchpad CodeImport
 
-Launchpad is an open source suite of tools that help people and teams to work
-together on software projects.  Unlike many open source projects, Launchpad
-isn't something you install and run yourself (although you are welcome to do
-so), instead, contributors help make <https://launchpad.net> better.
+**Launchpad CodeImport** is responsible for managing the code import functionality within Launchpad. For more information about Launchpad, visit [Launchpad Documentation](https://documentation.ubuntu.com/launchpad/en/latest/).
 
-Launchpad is a project of Canonical <http://www.canonical.com> and has
-received many contributions from many wonderful people
-<https://dev.launchpad.net/Contributions>.
+## Getting Started
 
-If you want help using Launchpad, then please visit our help wiki at:
+### Prerequisites
 
-    https://help.launchpad.net
+1. Install and set up [LXD](https://canonical.com/lxd/install).
+2. *(Optional)* Set up the [LXD Web UI](https://documentation.ubuntu.com/lxd/latest/tutorial/ui/) for easier profile management.
 
-If you'd like to contribute to Launchpad, have a look at:
+### Setting Up LP CodeImport
 
-    https://dev.launchpad.net
+Follow the steps below to set up LP CodeImport:
 
-Alternatively, have a poke around in the code, which you probably already know
-how to get if you are reading this file.
+1. **Launch an LXD container running Ubuntu Focal**
 
+   You can also create a custom LXD profile to mount a local directory inside the container. This is particularly useful for Git operations requiring SSH authentication, as it eliminates the need to copy your SSH key into the container.
 
-Getting started
-===============
+   ```yaml
+   # You can also create the profile via the LXD UI
+   cat <<EOF | lxc profile edit lp-codeimport
+   config:
+   raw.idmap: |
+      uid 1000 1000
+      gid 1000 1000
+   description: lp-codeimport
+   devices:
+   home:
+      path: /home/ubuntu/lp-codeimport
+      source: <mount-path-to-on-your-local-host>/lp-codeimport
+      type: disk
+   name: lp-codeimport
+   EOF
+   ```
+   
+   # Launch the container
+   lxc launch ubuntu:focal lp-codeimport
+   ```
 
-There's a full guide for getting up-and-running with a development Launchpad
-environment at <https://dev.launchpad.net/Getting>.  When you are ready to
-submit a patch, please consult <https://dev.launchpad.net/PatchSubmission>.
+2. **Clone the LP CodeImport repository**
 
-Our bug tracker is at <https://bugs.launchpad.net/launchpad/> and you can get
-the source code any time by doing:
+   ```
+   lxc exec lp-codeimport-focal -- sudo --user ubuntu --login
+   git clone https://git.launchpad.net/lp-codeimport
+   ```
 
-  $ git clone https://git.launchpad.net/launchpad
+3. **Update the container and install required system packages**
 
+   ```
+   sudo apt -y update
+   cd /home/ubuntu/lp-codeimport
+   cat system-dependencies.txt | xargs sudo apt install -y
+   ```
 
-Navigating the tree
--------------------
+4. **Build LP CodeImport**
 
-The Launchpad tree is big, messy and changing.  Sorry about that.  Don't panic
-though, it can sense fear.  Keep a firm grip on `grep` and pay attention to
-these important top-level folders:
+   ```
+   make
+   ```
 
-  bin/, utilities/
-    Where you will find scripts intended for developers and admins.  There's
-    no rhyme or reason to what goes in bin/ and what goes in utilities/, so
-    take a look in both.
+5. **Run the test suite**
 
-  configs/
-    Configuration files for various kinds of Launchpad instances.
-    'development' and 'testrunner' are of particular interest to developers.
-
-  cronscripts/
-    Scripts that are run on actual production instances of Launchpad as
-    cronjobs.
-
-  daemons/
-    Entry points for various daemons that form part of Launchpad
-
-  database/
-    Our database schema, our sample data, and some other stuff that causes
-    fear.
-
-  doc/
-    General system-wide documentation. You can also find documentation on
-    <https://dev.launchpad.net>, in docstrings and in doctests.
-
-  lib/
-    Where the vast majority of the code lives, along with our templates, tests
-    and the bits of our documentation that are written as doctests. 'lp' and
-    'canonical' are the two most interesting packages. Note that 'canonical'
-    is deprecated in favour of 'lp'.  To learn more about how the 'lp' package
-    is laid out, take a look at its docstring.
-
-  Makefile
-    Ahh, bliss.  The Makefile has all sorts of goodies.  If you spend any
-    length of time hacking on Launchpad, you'll use it often.  The most
-    important targets are 'make clean', 'make compile', 'make schema', 'make
-    run' and 'make run_all'.
-
-  scripts/
-    Scripts that are run on actual production instances of Launchpad,
-    generally triggered by some automatic process.
-
-
-You can spend years hacking on Launchpad full-time and not know what all of
-the files in the top-level directory are for.  However, here's a guide to some
-of the ones that come up from time to time.
-
-  bzrplugins/
-    Bazaar plugins used in running Launchpad.
-
-  sourcecode/
-    A directory into which we symlink branches of some of Launchpad's
-    dependencies.  Don't ask.
+   ```
+   bin/test -pvc -t .
+   ```
diff --git a/system-dependencies.txt b/system-dependencies.txt
index 41e6d17..00bd86f 100644
--- a/system-dependencies.txt
+++ b/system-dependencies.txt
@@ -1,11 +1,8 @@
 build-essential
-cvs
 git
 libffi-dev
 libssl-dev
-libsvn-dev
 python3-dev
 python3-pkg-resources
 rabbitmq-server
-subversion
-virtualenv
+python3-virtualenv