Package: udata-gouvfr
udata-gouvfrudata customizations for Etalab / Data.gouv.fr.Note:This is audataextension, you should read theudata documentationfirst.Compatibilityudata-gouvfrrequires Python 3.7+ andudata.InstallationInstalludata.Remain in the same Python virtual environment
and installudata-gouvfr:pipinstalludata-gouvfrCreate a local configuration fileudata.cfgin yourudatadirectory
(or where your UDATA_SETTINGS point out) or modify an existing one as following:PLUGINS=['gouvfr']THEME='gouvfr'DevelopmentPrepare audata development environment.Note that we're usingpip-toolson this repository too.It is recommended to have a workspace with the following layout:$WORKSPACE├──fs
├──udata
│├──...
│└──setup.py
├──udata-gouvfr
│├──...
│└──setup.py
└──udata.cfgThe following steps use the same Python virtual environment
and the same version of npm (for JS) asudata.Clone theudata-gouvfrrepository into your workspace
and install it in development mode:gitclonehttps://github.com/etalab/udata-gouvfr.gitcdudata-gouvfr
pre-commitinstall
pipinstall-e.-rrequirements/test.pip-rrequirements/develop.pipNB: theudata.(in|pip)files are used by the CI to stay in sync withudatarequirements. You shouldn't need to tinker with them on your local environment, but they might be updated by the CI when you make a Pull Request.Modify your localudata.cfgconfiguration file as following:PLUGINS=['gouvfr']THEME='gouvfr'You can executeudata-gouvfrspecific tasks from theudata-gouvfrdirectory.ex:Build the assets:cdudata-gouvfr
npminstall
invassets-buildYou can list available development commands with:inv-lThemeThe front-end theme for the public facing website, is split into two parts :TheJinjatemplates are located insideudata_gouvfr/theme/templates.TheLess& other sourcefiles for the are located intheme.In addition we have a nice litle set of CSS Utilities to quickly build front end components, inspired by bootstrap, most of its documentation
lives in the css located intheme/less/and is built usingStylemark, you can read the live documentation
inudata_gouvfr/theme/stylemark/after building it usingnpm run build-stylemark.When building pages, here are a few templates to look out for inudata_gouvfr/theme/templates:home.html: well, duh.header.htmlandfooter.html: same idea.raw.html: contains the general html structure exposing abodyblock where we can write our page's body.base.html: contains some extra html structure exposing acontentblock for our page's content.subnav-large.html,publish-action-modal.htmlandcarousel.html:TODOHere are our reusable components :dataset: datasets listings used in many pages.reuse: cards for displaying dataset reused in the real world.participez: is the large blue callout seen on multiple pages.macros:TODOsvg: contains SVG assets to be included in our pages.TODOFront docs todo :Parcel 2 architectureStatic copyStylemark buildVueJS compiler modeVanillaJS IIFE architectureVue 3 architectureModalsI18nConfig pluginComponents
Back docs todo :CSS/JS file inclusionStatic route for UI-KitWhenever a components needs some special styling, you can find their corresponding definitions insidetheme/less/specific/<component>,
it's best if we can avoid having too much specific styling, but sometimes you just really need it.Finally, we have a bunch of commands to make your life a tad easier, that you can run throughnpm run.build: Builds the final CSS/JS files and the UI-Kit Documentation. You should probably use this one.build:app: Builds the final CSS/JS files without the UI-Kitbuild:stylemark: Builds the UI-Kit files and also the CSS/JS files but unminifed (do not use those static files in production)i18n:report: Generates a report of the i18n missing and unused keysi18n:extract: Same as above, but also automatically adds missing keys to translation filesclean: Cleans Parcel cache. Use this if you stumble upon weird bugs to start anew.start: Get to coding with live reload and thingsChangelog3.1.0 (2021-08-31)Add About in header#623Add link to profile in admin for sysadmin#624Remove 'Sort by' button on organization pages#632:warning: Use pip-tools for dependency management:#626#631Documentation for installhere3.0.7 (2021-08-17)Update crowdin translations#6223.0.6 (2021-08-16)Update homepage wording#617Change banner trigger for geo.data.gouv.fr#618Show private datasets and reuses on organization page#619Make frontend banner configurable and remove newsletter banner settings#6213.0.5 (2021-08-12)Add a banner on geo.data.gouv.fr's datasets#6073.0.4 (2021-08-12)Replace mdstrip filter with markdown in resources descriptions#606Fix numerous responsive issues and prevent VueJS from crashing the page on compilation error#605Replace old COVID-19 inventory button with the new one for santé#608Add SPD datasets to home page#609Remove duplicate Participate block on dataset page#611Add redirect to dataset on submit for suggest search#6123.0.3 (2021-07-30)Add new translations#603Add vue sentry logging on gouvfr#594Add all featured topics button on homepage#597Resources descriptions are no longer truncated#596Fix URL for dataset search params#5953.0.2 (2021-07-19)Add organization search#593Fix reuses filters issue#592Remove suggest on mobile#590Added homepage "venti" button for the new inventory#5913.0.1 (2021-07-09)Fix datasets search pagination reset#588Replace link to /search route by /datasets#587Removed useless templates, views and tests after v3#557Fix datasets search pagination#5853.0.0 (2021-07-07):warning:breaking change: most of the theme/templates logic has been moved fromhttps://github.com/opendatateam/udatato this repo.udatano longer contains a default theme. In the 3.x series, we hope it will be usable as a "headless" open data platform, but for now you probably need to plug your own theme or use udata-gouvfr.More info about this change here.#4922.6.2 (2021-05-25)New translations#5352.6.1 (2021-05-25)Add new translations#5182.6.0 (2021-05-25)[maaf] fix encoding issue#531Add link to support page#532UX enhancement#525:Removed hero's background image.Removed home page's carrousel.Changed homepage's layout. Datasets are now on top followed by reuses.Renamed "Profile" to "Public profile"2.5.5 (2021-04-02)Thanks for all the fish#5292.5.4 (2021-03-31)🦀2.5.3 (2021-03-23)Add venv activation in CircleCI's publish step#5262.5.2 (2021-03-22)Keep tracking to strictly necessary#517Changed the title of the elections inventory page#5202.5.1 (2021-01-26)New Crowdin translations#5112.5.0 (2021-01-25)Add Inventory cards on homepage#514Add documentation's dropdown menu with links to technical documentation and open data guides#5162.3.0 (2020-11-30)Read Only Mode modifications on theme#509:Will display a warning banner on the frontend view.Hides the contribute's home's modal.Hides the Reuse's creation card and community resource's creation card on dataset view.Newsletter's subscription banner#512:Override alert section in posts list template to display newsletter's subscription banner.Add settingsPOST_BANNER_ACTIVATEDto toggle banner's activation.Add settingsPOST_BANNER_LINKandPOST_BANNER_MESSAGEto configure subscription's link and message.2.2.3 (2020-11-09)Add news link to posts list#5042.2.2 (2020-10-16)Pinned udata version to fix transitive requests dependencies#5002.2.1 (2020-10-16)Banner is now generic and configurable#499Fix links in static pages2.2.0 (2020-08-25)Show api.gouv.fr APIs on dataset page#4932.1.5 (2020-08-05)Mise à jour de l'URL de Geo SIRENE#489Add footer link to pages summary and page cache#4882.1.4 (2020-06-29)Add static /pages/* from md in github repo#4832.1.3 (2020-06-16)Fix packaging2.1.1 (2020-06-11)Adding banner with setting inherited from udata's settings#4802.1.0 (2020-05-13)Remove public services metrics#4722.0.2 (2020-04-22)Ajout duflag"recherche" pour activer lewidgetd'experimentation de recherche#4662.0.1 (2020-03-24)Add covid-19 badge for datasets and reuses#4732.0.0 (2020-03-11)Migrate to python3 🐍#4531.6.13 (2019-12-13)Ajout de l'identifiant SPDX pour la licence Ouverte 2.0#437Lien vers la doc d'API externe dans le footer#438Mise à jour de l'URL de Geo SIRENE#4461.6.12 (2019-09-11)Nouvelle section contact dans le pied de page#428Suppression du konami code#4291.6.11 (2019-07-11)New social logo (og:image)#4191.6.10 (2019-06-26)Data catalog: id as ref instead of slug#415Add cache for topic display page#414Fix card size on dataset page#4181.6.9 (2019-06-07)Switch removal of related tags in a topic page to a properrelatedjinja tag#408Add the homologation of IGN licenses#4121.6.8 (2019-05-29)Minor edits on SPD#406Change certification visual location in cards#4071.6.7 (2019-05-23)Set org logo to max width#403Add data catalog link to footer#4041.6.6 (2019-05-20)Remove clutter from search bar#400Add the homologation of INPI licenses#4021.6.5 (2019-05-10)Home blog post extraction improvements. Supports both Atom and RSS 2.0, more image tag formats,media:thumbnailand enclosures.#385Pin version ofrequests#397Improve header menu legibility#3881.6.4 (2019-03-27)Updates topic entry page#3821.6.3 (2019-03-06)Remove "compte des collectivités" from territories#376Push discussion under reuses and community resources3781.6.2 (2018-11-17)Konami code 🥚#362NB: this is not a release worth installing except ondata.gouv.fr.1.6.1 (2018-11-05)Add a BAL badge#347Remove TOS opt-in subtext#3491.6.0 (2018-10-02)Make use of assets manifest for long term caching#328Discussion add card style coherence#339Remove a duplicate rule on.dataset-container h31.4.4 (2018-08-27)Fix the multisearch labels position#3301.4.3 (2018-08-08)Fix the navbar toggle button position 🎊#3271.4.2 (2018-07-30)Add a reference on the page about SPD#3181.4.1 (2018-06-06)Fix packaging1.4.0 (2018-06-06)Typed resources related styles#265Enforce a domain whitelist when resource.filetype is file (migration)#292Use new pypi.org links#295Ensure active users have a confirmed_at date (migration)#298Remove credits page#306Fixmodal-lgwidth#311Add tracking and privacy page#3101.3.2 (2018-03-28)Limit number of forum topics#284Use new OEmbed cards in datasets recommandations#285Fix the RSS popover not being clickable#287Drop the custom style for non-certified datasets#2881.3.1 (2018-03-15)Fix some cards positionning1.3.0 (2018-03-13)Make use ofudata pytest plugin#254Expose new entrypoints. Plugins and theme translations are now splitted#263Align card components design#252#272Discourse timeout and response parse error catch#267Add tracking on home page call to action#271Add tracking on carousel elements#268Temporary carousel layout#274Add tracking of dataset recommendations#2771.2.5 (2018-02-05)Small fixes on search facets related toopendatateam/udata#1410#2551.2.4 (2018-01-24)Licenses: Update SHOM attachment + fix BAN URL#2491.2.3 (2018-01-17)Add the homologation of CC-BY-SA for SHOM#244Dataset recommendations#243Move some discussions style intoudatacore#2511.2.2 (2017-12-14)Export CSS dropdown behavior toudata#234Remove internal FAQ and switch todoc.data.gouv.fr#2361.2.1 (2017-12-06)Export community resource avatar style to udata#233Drop theterms.htmltemplate. Terms and conditions are now externalized and use the udata core template. (Seeudata#1285)#2321.2.0 (2017-10-20)Use new search blueprint from uData#2241.1.2 (2017-09-04)Fixes some spacing issues on dataset and reuses page buttons#209Fix some wrong spatial coverages#213Fix translations collision on contact#211#212Updated some translations1.1.1 (2017-07-31)Updated translations1.1.0 (2017-07-05)Use the new entrypoint-based theme management#164Adjust the dataset reuses title overflow for proper display#172Drop glyphicons, remove some useless classes and upgrade to bootstrap 3.3.7#177Use the core publish action modal#178Fix the deuil header not being an SVG#180Integrating latest versions of GeoZones and GeoLogos for territories.
Especially using history of towns, counties and regions from GeoHisto.#499Add the missing placeholders#194Use theudata.harvestersentrypoint#195Revamp actionnable tabs#189Remove.btn-moreclass#1911.0.9 (2017-06-28)Nothing yet1.0.8 (2017-06-21)Fixed a typo#1821.0.7 (2017-06-20)Added a Licences page#1811.0.6 (2017-04-18)Fixed numbering in system integrator FAQ (thanks to Bruno Cornec)#174Added a footer link to the SPD page#1761.0.5 (2017-04-06)Added a missing translationAlphabetical ordering on SPD datasets1.0.4 (2017-04-05)Introduce SPD page and badge1.0.3 (2017-02-27)Translations updateSwitchudata-jslink tometaclic#1611.0.2 (2017-02-21)Optimize png images from theme#159Optimize png images sizes for territory placeholders#7881.0.1 (2017-02-20)Ensure missing FAQ sections raises a 404#156Provide deep PyPI versions links into the footer#155Provide proper cache versionning for theme assets#1551.0.0 (2017-02-16)Remove some main menu entries (events, CADA, Etalab)Use a new SVG logoApply changes fromuData 1.0.00.9.1 (2017-01-10)First published release