HackMD
  • New!
    New!  “Bookmark” and save your note
    Find a note that's worth keeping or want reading it later? “Bookmark” it to your personal reading list.
    Got it
      • Create new note
      • Create a note from template
    • New!  “Bookmark” and save your note
      New!  “Bookmark” and save your note
      Find a note that's worth keeping or want reading it later? “Bookmark” it to your personal reading list.
      Got it
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
      • ODF (Beta)
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Write
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Gist
    Import
    Dropbox Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML ODF (Beta)
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Owners
    • Owners
    • Signed-in users
    • Everyone
    Owners Signed-in users Everyone
    Write
    Owners
    • Owners
    • Signed-in users
    • Everyone
    Owners Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note    
    Published Linked with
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # CKAN Python 3 support roadmap ## Overview With the end of official support for Python 2.7 coming up on the end of this year we need to have a clear roadmap of what needs to happen to get full Python 3 support before that. It is unlikely that we will be fully migrated (as in the whole project being Python 3 only) but we should aim to have a release in place by then that can run both Python 2 and 3. As discussed previously, we will aim for a transition release where the same code base supports both versions, before dropping all Python 2 support in the next one: * CKAN 2.8 (current) - Python 2 only * CKAN 2.9 - Python 2 and 3 * CKAN 3.0 (*) - Python 3 only (*) Major version changes are the time to break compatibilities, so if all the changes are internal py3 ones we might want to save the major number change for future changes on API, frontend, etc. Something to think about. ### How this roadmap works The following is a collection of tasks that need to happen to get us to these releases. They are different in size, they need to happen at different points in time and some are blocked by others. This will be reflected as precisely as possible on an appropriate tool like GitHub projects, but the goal is to have a GitHub issue for each of this tasks, that can be assigned and tracked. All issues will be clearly labeled, including these that are Blocked, Good for Contribution (there are several of these) or even Beginner Friendly (there are some of these). The number of tasks might look daunting but the truth is that only three or four of them are really big and complex tasks, with only a couple of major blockers. The rest are self-contained, and most of them can be tackled by developers with different degrees of experience. I've tried to give as much detail as possible on the Approach section so it's clear what needs to be done to implement them. But of course, the further we go into the future the more unknowns we will find. A quick word on estimates. Estimating is hard and with a project like this involving different stages and multiple tasks even more. What's more we want to get as much help on this as possible so we need to consider different degrees of familiarity with CKAN (eg same task might take X to a core dev but Y to someone with less experience) I know that ideally people would like to see hours or days put down but I don't think is realistic at this stage. Instead I've borrowed the concept of Story Points from agile methodologies. They are a scale of Fibonnaci-like values that take into account aspects like Amount of Work, Risk and Complexity. There are different scales and interpretations, I just picked one an stuck with it: ![](https://i.imgur.com/S6LxDJA.png) Here are [some](https://www.mountaingoatsoftware.com/blog/what-are-story-points) [resources](https://www.atlassian.com/agile/project-management/estimation) on [story points](https://medium.com/@mdalmijn/12-common-mistakes-made-when-using-story-points-f0bb9212d2f7). ## Stages As mentioned in the previous section the process can be roughly split in these three phases: 1. **Enabling Python 3** If the first goal is to be able to run CKAN in Python 3 the priority is to remove any Python 2 only requirement. Most of the work to remove the biggest one (Pylons) is done, but there's still vdm and other minor requirements that block the transition. These should be the top priority over the next months. Main risks for this stage: * Removing VDM: just because of its pervasiveness * Replacing/Upgrading pyutilib: as it touches the critical feature of plugins interfaces, which needs extra care to avoid breaking compatibility 2. **Transition** Once we can run CKAN with a set of requirements that supports Python 3 we need to make sure that the core codebase can run on it and that all tests pass. There has been extensive work done on that front already, but quick preliminary tests show that there are still issues to be ironed out and no doubt new ones will come up. Also we need to focus on extensions, developing a clear upgrade path and documenting changes. Main risks for this stage: * Extensions that need to support multiple CKAN (and Python) versions: we haven't explored much the options there 3. **Cleanup** After the transition version is out we can finally remove all Python 2 only requirements and associated code, as well as the custom middleware and common logic to support requests to Pylons and Flask, etc ## Tasks The following tasks have all been defined as GitHub issues in the [main CKAN repo](https://github.com/ckan/ckan/issues?q=is%3Aissue+is%3Aopen+label%3A%22Python+3%22). They are laid out and prioritized in the [Python 3 Support](https://github.com/ckan/ckan/projects/3) project in the same repo. ![GitHub Project](https://i.imgur.com/9vHM6fA.png) The issues and project in the repo are the reference place for them, below there is a summary provided for convenience: ### Enabling * Migrate controllers from core extensions to blueprints ([#4791](https://github.com/ckan/ckan/issues/4791)) * Remove VDM ([#4783](https://github.com/ckan/ckan/issues/4783)) * Remove or replace formencode support ([#4800](https://github.com/ckan/ckan/issues/4800)) * Replace webhelpers with a modern alternative ([#4794](https://github.com/ckan/ckan/issues/4794)) * Replace pyutilib.component.core with a modern alternative ([#4795](https://github.com/ckan/ckan/issues/4795)) * Replace repoze.who-friendlyform with a modern alternative ([#4796](https://github.com/ckan/ckan/issues/4796)) * Write a Flask and Python 3 migration guide for extensions ([#4792](https://github.com/ckan/ckan/issues/4792)) ### Transition * Implement changes to allow running CKAN in both Python 2 and 3 ([#4801](https://github.com/ckan/ckan/issues/4801)) * Replace paste.script with Click ([#4639](https://github.com/ckan/ckan/issues/4639)) * Flask and Python 3 support on selected extensions ([#4793](https://github.com/ckan/ckan/issues/4793)) * Replace paste.deploy converters ([#4797](https://github.com/ckan/ckan/issues/4797)) * Don't use paste.deploy appconfig to parse the ini file ([#4798](https://github.com/ckan/ckan/issues/4798)) * Don't use paste.deploy to create the extension template ([#4799](https://github.com/ckan/ckan/issues/4799)) * Update the WSGI entrypoint to not use paste.deploy ([#4802](https://github.com/ckan/ckan/issues/4802)) * Replace paster make-config ([#4803](https://github.com/ckan/ckan/issues/4803)) ### Cleanup * Remove Fanstatic ([#4804](https://github.com/ckan/ckan/issues/4804)) * Remove AppDispatcher and Pylons middleware ([#4805](https://github.com/ckan/ckan/issues/4805)) * Remove vars in templates context set in views ([#4806](https://github.com/ckan/ckan/issues/4806)) * Remove all remaining Pylons code in core ([#4807](https://github.com/ckan/ckan/issues/4807))

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.
    All
    • All
    • Team
    No template found.

    Create a template

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in via Google

    New to HackMD? Sign up

    Help

    Documents

    Tutorials
    YAML Metadata
    Slide Example
    Book Example

    Contacts

    Talk to us
    Report an issue
    Send us email

    Cheatsheet

    Example Syntax
    Header # Header
    • Unordered List
    - Unordered List
    1. Ordered List
    1. Ordered List
    • Todo List
    - [ ] Todo List
    Blockquote
    > Blockquote
    Bold font **Bold font**
    Italics font *Italics font*
    Strikethrough ~~Strikethrough~~
    19th 19^th^
    H2O H~2~O
    Inserted text ++Inserted text++
    Marked text ==Marked text==
    Link [link text](https:// "title")
    Image ![image alt](https:// "title")
    Code `Code`
    var i = 0;
    ```javascript
    var i = 0;
    ```
    :smile: :smile:
    Externals {%youtube youtube_id %}
    LaTeX $L^aT_eX$

    This is a alert area.

    :::info
    This is a alert area.
    :::

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully